sphinx-quickstart¶
Synopsis¶
sphinx-quickstart
Description¶
sphinx-quickstart is an interactive tool that asks some questions about your project and then generates a complete documentation directory and sample Makefile to be used with sphinx-build(1).
Options¶
-
-q,--quiet¶ Quiet mode that will skips interactive wizard to specify options. This option requires -p, -a and -v options.
-
-h,--help,--version¶ Display usage summary or Sphinx version.
Structure Options
-
--sep¶ If specified, separate source and build directories.
-
--dot=DOT¶ Inside the root directory, two more directories will be created; “_templates” for custom HTML templates and “_static” for custom stylesheets and other static files. You can enter another prefix (such as “.”) to replace the underscore.
Project Basic Options
-
--suffix=SUFFIX¶ Source file suffix. (see
source_suffix).
-
--master=MASTER¶ Master document name. (see
master_doc).
-
--epub¶ Use epub.
Extension Options
-
--ext-autodoc¶ Enable sphinx.ext.autodoc extension.
-
--ext-doctest¶ Enable sphinx.ext.doctest extension.
-
--ext-intersphinx¶ Enable sphinx.ext.intersphinx extension.
-
--ext-todo¶ Enable sphinx.ext.todo extension.
-
--ext-coverage¶ Enable sphinx.ext.coverage extension.
-
--ext-imgmath¶ Enable sphinx.ext.imgmath extension.
-
--ext-mathjax¶ Enable sphinx.ext.mathjax extension.
-
--ext-ifconfig¶ Enable sphinx.ext.ifconfig extension.
-
--ext-viewcode¶ Enable sphinx.ext.viewcode extension.
-
--extensions=EXTENSIONS¶ Enable arbitary extensions.
Makefile and Batchfile Creation Options
-
--use-make-mode,--no-use-make-mode¶ Makefile/make.batuses (or doesn’t use) make-mode. Default isuse, which generates a more conciseMakefile/make.bat.Changed in version 1.5: make-mode is default.
-
--makefile,--no-makefile¶ Create (or not create) makefile.
-
--batchfile,--no-batchfile¶ Create (or not create) batchfile
Project templating
New in version 1.5: Project templating options for sphinx-quickstart
-
-t,--templatedir=TEMPLATEDIR¶ Template directory for template files. You can modify the templates of sphinx project files generated by quickstart. Following Jinja2 template files are allowed:
master_doc.rst_tconf.py_tMakefile_tMakefile.new_tmake.bat_tmake.bat.new_t
In detail, please refer the system template files Sphinx provides. (
sphinx/templates/quickstart)
-
-dNAME=VALUE¶ Define a template variable
See also¶
sphinx-build(1)