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

SEE ALSO

136       sphinx-build(1)
137

139       2007-2020, Georg Brandl and the Sphinx team
140
141
142
143
1442.2.2                            Jan 30, 2020             SPHINX-QUICKSTART(1)
Impressum