Skip to content

Commit

Permalink
Merge pull request #22 from sdfordham/patch-1
Browse files Browse the repository at this point in the history
Update README.rst
  • Loading branch information
SilverRainZ committed Feb 13, 2023
2 parents 12509c5 + ee48dd0 commit 956042a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Sphinx to GitHub Pages V3
.. image:: https://img.shields.io/github/stars/sphinx-notes/pages.svg?style=social&label=Star&maxAge=2592000
:target: https://github.com/sphinx-notes/pages

Help you deploying your Sphinx documentation to Github Pages.
Helps you deploy your Sphinx documentation to Github Pages.

.. warning:: v3 is **in beta and subject to change**, use v2__ if you need a stable version.

Expand Down Expand Up @@ -82,25 +82,25 @@ The following repository's pages are built by this action:
- https://github.com/sphinx-notes/strike
- `and more...`__

You can found the workflow file in aboved repositories.
You can find the workflow file in the above repositories.

__ https://github.com/sphinx-notes/pages/network/dependents

Tips
====

Copy extra files to site
========================
************************

Use Sphinx confval html_extra_path__.

__ https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path

Cancel any in-progress job
==========================
**************************

It is useful when you have pushed new commit to remote but the job of previous
commit is not finished yet. see concurrency__ for more details.
It is useful when you have pushed a new commit to remote but the job of the previous
commit is not finished yet. See concurrency__ for more details.

.. code-block:: yaml
Expand Down

0 comments on commit 956042a

Please sign in to comment.