Scroll to navigation



sphinx-quickstart - Sphinx documentation template generator




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).


-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.INDENT 0.0
If specified, separate source and build directories.

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.INDENT 0.0
-p PROJECT, --project=PROJECT
Project name will be set. (see project).

-a AUTHOR, --author=AUTHOR
Author names. (see copyright).

Version of project. (see version).

-r RELEASE, --release=RELEASE
Release of project. (see release).

-l LANGUAGE, --language=LANGUAGE
Document language. (see language).

Source file suffix. (see source_suffix).

Master document name. (see master_doc).

Use epub.

Extension Options.INDENT 0.0
Enable sphinx.ext.autodoc extension.

Enable sphinx.ext.doctest extension.

Enable sphinx.ext.intersphinx extension.

Enable sphinx.ext.todo extension.

Enable sphinx.ext.coverage extension.

Enable sphinx.ext.imgmath extension.

Enable sphinx.ext.mathjax extension.

Enable sphinx.ext.ifconfig extension.

Enable sphinx.ext.viewcode extension.

Enable arbitrary extensions.

Makefile and Batchfile Creation Options.INDENT 0.0
--use-make-mode, --no-use-make-mode
Makefile/make.bat uses (or doesn’t use) make-mode. Default is use, which generates a more concise Makefile/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_t
  • conf.py_t
  • Makefile_t
  • Makefile.new_t
  • make.bat_t
  • make.bat.new_t

In detail, please refer the system template files Sphinx provides. (sphinx/templates/quickstart)

Define a template variable




2007-2018, Georg Brandl and the Sphinx team
October 22, 2018 1.7.9