snippetbashTip

sphinx-build — Sphinx documentation generator. More information: <https://www.sphinx-doc.org/en/master/man/sphinx-b

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

commandgeneratorsphinx-buildsphinxcliinformationdocumentationmore

Problem

How to use the sphinx-build command: Sphinx documentation generator. More information: <https://www.sphinx-doc.org/en/master/man/sphinx-build.html>.

Solution

sphinx-build — Sphinx documentation generator. More information: <https://www.sphinx-doc.org/en/master/man/sphinx-build.html>.

Build documentation:

sphinx-build {{[-b|--builder]}} {{html|epub|text|latex|man|...}} {{path/to/source_directory}} {{path/to/build_directory}}

Build documentations intended for readthedocs.io (requires the sphinx-rtd-theme pip package):

sphinx-build {{[-b|--builder]}} {{html}} {{path/to/docs_directory}} {{path/to/build_directory}}

Code Snippets

Build documentation

sphinx-build {{[-b|--builder]}} {{html|epub|text|latex|man|...}} {{path/to/source_directory}} {{path/to/build_directory}}

Build documentations intended for readthedocs.io (requires the sphinx-rtd-theme pip package)

sphinx-build {{[-b|--builder]}} {{html}} {{path/to/docs_directory}} {{path/to/build_directory}}

Context

tldr-pages: common/sphinx-build

Revisions (0)

No revisions yet.