mirror of https://github.com/CrimsonTome/tldr.git
13 lines
420 B
Markdown
13 lines
420 B
Markdown
|
# sphinx-build
|
||
|
|
|
||
|
|
> Sphinx documentation generator.
|
||
|
|
> More information: <http://www.sphinx-doc.org/en/master/man/sphinx-build.html>.
|
||
|
|
|
||
|
|
- Build documentation:
|
||
|
|
|
||
|
|
`sphinx-build -b {{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 {{html}} {{path/to/docs_dir}} {{path/to/build_dir}}`
|