1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-29 23:24:55 +02:00
tldr/pages/common/sphinx-build.md

12 lines
453 B
Markdown

# 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_dir}} {{path/to/build_dir}}`
- Build documentations intended for readthedocs.io (requires the sphinx-rtd-theme pip package):
`sphinx-build {{[-b|--builder]}} {{html}} {{path/to/docs_dir}} {{path/to/build_dir}}`