sphinx-quickstart1
Sphinx documentation template generator
Usage
sphinx-quickstart
Overview
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 skips the interactive wizard for specifying 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.
-
--no-sep -
If specified, create build directory under source directory.
-
--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
-
-p PROJECT, --project=PROJECT -
Project name will be set. (see
project<#confval-project>).
-
-a AUTHOR, --author=AUTHOR -
Author names. (see
copyright<#confval-copyright>).
-
-v VERSION -
Version of project. (see
version<#confval-version>).
-
-r RELEASE, --release=RELEASE -
Release of project. (see
release<#confval-release>).
-
-l LANGUAGE, --language=LANGUAGE -
Document language. (see
language<#confval-language>).
-
--suffix=SUFFIX -
Source file suffix. (see
source_suffix<#confval-source_suffix>).
-
--master=MASTER -
Master document name. (see
root_doc<#confval-root_doc>).
Extension Options
-
--ext-autodoc -
Enable
sphinx.ext.autodoc<#module-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.
-
--ext-githubpages -
Enable sphinx.ext.githubpages extension.
-
--extensions=EXTENSIONS -
Enable arbitrary extensions.
Makefile and Batchfile Creation Options
-
--use-make-mode (-m), --no-use-make-mode (-M) -
Makefile/make.batuses (or doesn't use) make-mode <#make-mode>. Default isuse, which generates a more conciseMakefile/make.bat.Changed in version 1.5: make-mode is default.
Changed in version 7.3: Support for disabling the make-mode will be removed in Sphinx 8.
Removed in version 8.0: The
--no-use-make-modeoption. The--use-make-modenow has no effect.
-
--makefile, --no-makefile -
Create (or not create) makefile.
-
--batchfile, --no-batchfile -
Create (or not create) batchfile
Project templating
Added 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:
- •
-
root_doc.rst.jinja
- •
-
conf.py.jinja
- •
-
Makefile.jinja
- •
-
Makefile.new.jinja
- •
-
make.bat.jinja
- •
-
make.bat.new.jinja
In detail, please refer the system template files Sphinx provides. (
sphinx/templates/quickstart)
-
-d NAME=VALUE -
Define a template variable
Releases
10 releases since Debian 5.0 (Lenny); the text changed 9 times.
--author since Debian 10 (Buster);
--batchfile since Debian 10 (Buster);
--dot since Debian 10 (Buster);
--ext-autodoc since Debian 10 (Buster);
--ext-coverage since Debian 10 (Buster);
--ext-doctest since Debian 10 (Buster);
--ext-githubpages since Debian 10 (Buster);
--ext-ifconfig since Debian 10 (Buster);
--ext-imgmath since Debian 10 (Buster);
--ext-intersphinx since Debian 10 (Buster);
--ext-mathjax since Debian 10 (Buster);
--ext-todo since Debian 10 (Buster);
--ext-viewcode since Debian 10 (Buster);
--extensions since Debian 10 (Buster);
--help since Debian 10 (Buster);
--language since Debian 10 (Buster);
--makefile since Debian 10 (Buster);
--master since Debian 10 (Buster);
--no-batchfile since Debian 10 (Buster);
--no-makefile since Debian 10 (Buster);
--no-sep since Debian 11 (Bullseye);
--no-use-make-mode since Debian 10 (Buster);
--project since Debian 10 (Buster);
--quiet since Debian 10 (Buster);
--release since Debian 10 (Buster);
--sep since Debian 10 (Buster);
--suffix since Debian 10 (Buster);
--templatedir since Debian 10 (Buster);
--use-make-mode since Debian 10 (Buster);
--version since Debian 10 (Buster);
-a since Debian 10 (Buster);
-d since Debian 10 (Buster);
-h since Debian 10 (Buster);
-l since Debian 10 (Buster);
-p since Debian 10 (Buster);
-q since Debian 10 (Buster);
-r since Debian 10 (Buster);
-t since Debian 10 (Buster);
-v since Debian 10 (Buster).
--epub until Debian 10 (Buster).