Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork874
gh-1309: Document how to selectively build RST pages#1562
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -153,6 +153,25 @@ To build the docs as HTML, run: | ||
start a local server, and automatically reload the page in your | ||
willingc marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
browser when you make changes to reST files (Unix only). | ||
It is also possible to build only certain pages of the documentation in order | ||
to save time during the build process. Following is an example for building two | ||
pages: | ||
willingc marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
.. tab:: Unix/macOS | ||
.. code-block:: shell | ||
make html SOURCES="tutorial/classes.rst tutorial/inputoutput.rst" | ||
.. tab:: Windows | ||
See :ref:`using-sphinx-build`. When invoking ``sphinx-build``, pass the | ||
desired pages as the final parameter, like so: | ||
willingc marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
.. code-block:: dosbatch | ||
python -m sphinx -b html . build/html tutorial/classes.rst tutorial/inputoutput.rst | ||
To check the docs for common errors with `Sphinx Lint`_ | ||
(which is run on all :ref:`pull requests <pullrequest>`), use: | ||
Uh oh!
There was an error while loading.Please reload this page.