# sphinx-quickstart(1) - man - phpMan

[SPHINX-QUICKSTART(1)](https://www.chedong.com/phpMan.php/man/SPHINX-QUICKSTART/1/markdown)                           Sphinx                           [SPHINX-QUICKSTART(1)](https://www.chedong.com/phpMan.php/man/SPHINX-QUICKSTART/1/markdown)



## NAME
       sphinx-quickstart - Sphinx documentation template generator

## SYNOPSIS
### sphinx-quickstart

## DESCRIPTION
       **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)](https://www.chedong.com/phpMan.php/man/sphinx-build/1/markdown)**.

## OPTIONS
### -q, --quiet
              Quiet  mode that skips the interactive wizard for specifying options.  This option re‐
              quires _-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 cus‐
              tom  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**).

### -a AUTHOR, --author=AUTHOR
              Author names. (see **copyright**).

### -v VERSION
              Version of project. (see **version**).

### -r RELEASE, --release=RELEASE
              Release of project. (see **release**).

### -l LANGUAGE, --language=LANGUAGE
              Document language. (see **language**).

### --suffix=SUFFIX
              Source file suffix. (see **source**___**suffix**).

### --master=MASTER
              Master document name. (see **root**___**doc**).

       Extension Options

### --ext-autodoc
              Enable _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.bat** uses (or doesn't use) make-mode.  Default is **use**, which generates  a
              more concise **Makefile/make.bat**.

              Changed in version 1.5: make-mode is default.


### --makefile, --no-makefile
              Create (or not create) makefile.

### --batchfile, --no-batchfile
              Create (or not create) batchfile

       Project templating

       New 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**___**t**

              • **conf.py**___**t**

              • **Makefile**___**t**

              • **Makefile.new**___**t**

              • **make.bat**___**t**

              • **make.bat.new**___**t**

              In detail, please refer the  system  template  files  Sphinx  provides.   (**sphinx/tem**‐‐
              **plates/quickstart**)

### -d NAME=VALUE
              Define a template variable

## SEE ALSO
### [sphinx-build(1)](https://www.chedong.com/phpMan.php/man/sphinx-build/1/markdown)

## COPYRIGHT
       2007-2021, Georg Brandl and the Sphinx team




4.3.2                                       Dec 19, 2021                        [SPHINX-QUICKSTART(1)](https://www.chedong.com/phpMan.php/man/SPHINX-QUICKSTART/1/markdown)