Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
willingc merged 1 commit intopython:mainfromMichaByte:selective-build-doc-pages
Jun 16, 2025
Merged
Changes fromall commits
Commits
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
gh-1309: Document how to selectively build RST pages
  • Loading branch information
@MichaByte
MichaByte committedMay 19, 2025
commit6670c74b8900974930c2874e1ed368c1e2262d23
19 changes: 19 additions & 0 deletionsdocumentation/start-documenting.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -153,6 +153,25 @@ To build the docs as HTML, run:
start a local server, and automatically reload the page in your
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:

.. 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:

.. 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:

Expand Down
Loading

[8]ページ先頭

©2009-2025 Movatter.jp