.\" Man page generated from reStructuredText.
.
.TH "SPHINX-QUICKSTART" "1" "Oct 22, 2018" "1.7.9" "Sphinx"
.SH NAME
sphinx-quickstart \- Sphinx documentation template generator
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBsphinx\-quickstart\fP
.SH DESCRIPTION
.sp
\fBsphinx\-quickstart\fP 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 \fBsphinx\-build(1)\fP\&.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Quiet mode that will skips interactive wizard to specify options.
This option requires \fI\-p\fP, \fI\-a\fP and \fI\-v\fP options.
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help, \-\-version
Display usage summary or Sphinx version.
.UNINDENT
Structure Options.INDENT 0.0
.TP
.B \-\-sep
If specified, separate source and build directories.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-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.
.UNINDENT
Project Basic Options.INDENT 0.0
.TP
.B \-p PROJECT, \-\-project=PROJECT
Project name will be set. (see \fBproject\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-a AUTHOR, \-\-author=AUTHOR
Author names. (see \fBcopyright\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-v VERSION
Version of project. (see \fBversion\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-r RELEASE, \-\-release=RELEASE
Release of project. (see \fBrelease\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-l LANGUAGE, \-\-language=LANGUAGE
Document language. (see \fBlanguage\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-suffix=SUFFIX
Source file suffix. (see \fBsource_suffix\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-master=MASTER
Master document name. (see \fBmaster_doc\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-epub
Use epub.
.UNINDENT
Extension Options.INDENT 0.0
.TP
.B \-\-ext\-autodoc
Enable \fIsphinx.ext.autodoc\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-doctest
Enable \fIsphinx.ext.doctest\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-intersphinx
Enable \fIsphinx.ext.intersphinx\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-todo
Enable \fIsphinx.ext.todo\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-coverage
Enable \fIsphinx.ext.coverage\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-imgmath
Enable \fIsphinx.ext.imgmath\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-mathjax
Enable \fIsphinx.ext.mathjax\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-ifconfig
Enable \fIsphinx.ext.ifconfig\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ext\-viewcode
Enable \fIsphinx.ext.viewcode\fP extension.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-extensions=EXTENSIONS
Enable arbitrary extensions.
.UNINDENT
Makefile and Batchfile Creation Options.INDENT 0.0
.TP
.B \-\-use\-make\-mode, \-\-no\-use\-make\-mode
\fBMakefile/make.bat\fP uses (or doesn’t use) make\-mode\&.
Default is \fBuse\fP, which generates a more concise \fBMakefile/make.bat\fP\&.
.sp
Changed in version 1.5: make\-mode is default.

.UNINDENT
.INDENT 0.0
.TP
.B \-\-makefile, \-\-no\-makefile
Create (or not create) makefile.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-batchfile, \-\-no\-batchfile
Create (or not create) batchfile
.UNINDENT
Project templating
.sp
New in version 1.5: Project templating options for sphinx\-quickstart

.INDENT 0.0
.TP
.B \-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:
.INDENT 7.0
.IP \(bu 2
\fBmaster_doc.rst_t\fP
.IP \(bu 2
\fBconf.py_t\fP
.IP \(bu 2
\fBMakefile_t\fP
.IP \(bu 2
\fBMakefile.new_t\fP
.IP \(bu 2
\fBmake.bat_t\fP
.IP \(bu 2
\fBmake.bat.new_t\fP
.UNINDENT
.sp
In detail, please refer the system template files Sphinx provides.
(\fBsphinx/templates/quickstart\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \-d NAME=VALUE
Define a template variable
.UNINDENT
.SH SEE ALSO
.sp
\fBsphinx\-build(1)\fP
.SH COPYRIGHT
2007-2018, Georg Brandl and the Sphinx team
.\" Generated by docutils manpage writer.
.