From d950e757790700478e6f001fb27114d60737f4e9 Mon Sep 17 00:00:00 2001 From: NightMachinary <36224762+NightMachinary@users.noreply.github.com> Date: Wed, 31 Jul 2019 15:41:59 +0430 Subject: [PATCH] sphinx-build: add page (#3211) --- pages/common/sphinx-build.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 pages/common/sphinx-build.md 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}}`