Browse Source

sphinx-build: add page (#3211)

NightMachinary 5 years ago
parent
commit
d950e75779
1 changed files with 12 additions and 0 deletions
  1. 12 0
      pages/common/sphinx-build.md

+ 12 - 0
pages/common/sphinx-build.md

@@ -0,0 +1,12 @@
+# 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}}`