diff --git a/pages/common/sphinx-build.md b/pages/common/sphinx-build.md new file mode 100644 index 000000000..338beaf64 --- /dev/null +++ b/pages/common/sphinx-build.md @@ -0,0 +1,12 @@ +# sphinx-build + +> Sphinx documentation generator. +> More information: . + +- 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}}`