Skip to content

readme: use long options so it's more obvious what the option does #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

readme: use long options so it's more obvious what the option does #622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,17 @@ You can build the rendered version by running::

By default, Sphinx uses incremental rebuilds to generate the content that
changed since the last invocation. If you notice a problem with incremental
rebuilds, you can pass the ``-c`` flag to clear the existing artifacts before
rebuilds, you can pass the ``--clear`` flag to clear the existing artifacts before
building::

./make.py -c
./make.py --clear

The rendered version will be available in ``build/html/``.

You can also start a local server on port 8000 with automatic rebuild and reload
whenever you change a file by passing the ``-s`` flag::
whenever you change a file by passing the ``--serve`` flag::

./make.py -s
./make.py --serve

Checking links consistency
==========================
Expand Down