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

SEE ALSO

139       sphinx-build(1)
140

142       2007-2023, the Sphinx developers
143
144
145
146
1476.2.1                            Jul 27, 2023             SPHINX-QUICKSTART(1)
Impressum