1SPHINX-QUICKSTART(1)                Sphinx                SPHINX-QUICKSTART(1)
2
3
4

NAME

6       sphinx-quickstart - Sphinx documentation template generator
7

SYNOPSIS

9       sphinx-quickstart
10

DESCRIPTION

12       sphinx-quickstart is an interactive tool that asks some questions about
13       your project and then generates a complete documentation directory  and
14       sample Makefile to be used with sphinx-build(1).
15

OPTIONS

17       -q, --quiet
18              Quiet mode that will skip interactive wizard to specify options.
19              This option requires -p, -a and -v options.
20
21       -h, --help, --version
22              Display usage summary or Sphinx version.
23       Structure Options.INDENT 0.0
24
25       --sep  If specified, separate source and build directories.
26
27       --dot=DOT
28              Inside the root directory, two more directories will be created;
29              “_templates”  for custom HTML templates and “_static” for custom
30              stylesheets and other static files. You can enter another prefix
31              (such as “.”) to replace the underscore.
32       Project Basic Options.INDENT 0.0
33
34       -p PROJECT, --project=PROJECT
35              Project name will be set. (see project).
36
37       -a AUTHOR, --author=AUTHOR
38              Author names. (see copyright).
39
40       -v VERSION
41              Version of project. (see version).
42
43       -r RELEASE, --release=RELEASE
44              Release of project. (see release).
45
46       -l LANGUAGE, --language=LANGUAGE
47              Document language. (see language).
48
49       --suffix=SUFFIX
50              Source file suffix. (see source_suffix).
51
52       --master=MASTER
53              Master document name. (see master_doc).
54
55       --epub Use epub.
56       Extension Options.INDENT 0.0
57
58       --ext-autodoc
59              Enable sphinx.ext.autodoc extension.
60
61       --ext-doctest
62              Enable sphinx.ext.doctest extension.
63
64       --ext-intersphinx
65              Enable sphinx.ext.intersphinx extension.
66
67       --ext-todo
68              Enable sphinx.ext.todo extension.
69
70       --ext-coverage
71              Enable sphinx.ext.coverage extension.
72
73       --ext-imgmath
74              Enable sphinx.ext.imgmath extension.
75
76       --ext-mathjax
77              Enable sphinx.ext.mathjax extension.
78
79       --ext-ifconfig
80              Enable sphinx.ext.ifconfig extension.
81
82       --ext-viewcode
83              Enable sphinx.ext.viewcode extension.
84
85       --ext-githubpages
86              Enable sphinx.ext.githubpages extension.
87
88       --extensions=EXTENSIONS
89              Enable arbitrary extensions.
90       Makefile and Batchfile Creation Options.INDENT 0.0
91
92       --use-make-mode (-m), --no-use-make-mode (-M)
93              Makefile/make.bat  uses  (or doesn’t use) make-mode.  Default is
94              use, which generates a more concise Makefile/make.bat.
95
96              Changed in version 1.5: make-mode is default.
97
98
99       --makefile, --no-makefile
100              Create (or not create) makefile.
101
102       --batchfile, --no-batchfile
103              Create (or not create) batchfile
104       Project templating
105
106       New in version 1.5: Project templating options for sphinx-quickstart
107
108
109       -t, --templatedir=TEMPLATEDIR
110              Template directory for template files.  You can modify the  tem‐
111              plates of sphinx project files generated by quickstart.  Follow‐
112              ing Jinja2 template files are allowed:
113
114              · master_doc.rst_t
115
116              · conf.py_t
117
118              · Makefile_t
119
120              · Makefile.new_t
121
122              · make.bat_t
123
124              · make.bat.new_t
125
126              In detail, please refer the system template  files  Sphinx  pro‐
127              vides.  (sphinx/templates/quickstart)
128
129       -d NAME=VALUE
130              Define a template variable
131

SEE ALSO

133       sphinx-build(1)
134

136       2007-2019, Georg Brandl and the Sphinx team
137
138
139
140
1411.8.4                            Feb 13, 2019             SPHINX-QUICKSTART(1)
Impressum