SPHINX-QUICKSTART(1)                Sphinx                SPHINX-QUICKSTART(1)

<?><?><?> (NAME)
       sphinx-quickstart - <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> Sphinx

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       sphinx-quickstart

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> sphinx-quickstart <?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?> <?><?><?> <?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?>
       <?> <?><?> Makefile <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
       <?><?> sphinx-build(1) <?><?><?><?><?> <?><?><?><?><?><?>.

<?><?><?><?><?><?><?><?> (OPTIONS)

       -q, --quiet
              <?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?><?> -p<?> -a <?> -v <?><?><?><?>
              <?><?><?><?>.

       -h, --help, --version
              <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?> Sphinx.

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>

       --sep  <?><?> <?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?> (source)
              <?> <?><?><?><?> (build) <?><?> <?><?> <?><?><?><?><?><?>
              <?><?><?> <?><?><?><?><?><?>.

       --no-sep
              <?><?> <?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?>.

       --dot=DOT
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?> <?><?><?> "_templates" <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> HTML <?> "_static"
              <?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?> <?> <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?>. <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?> (<?><?><?><?><?> ".") <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?> (underscore)
              <?><?><?><?> <?><?><?><?>.

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>

       -p PROJECT, --project=PROJECT
              <?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
              <?><?>. (<?><?><?><?> <?><?><?><?> <?><?> project <#confval-
              project>).

       -a AUTHOR, --author=AUTHOR
              <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>. (<?><?><?><?>
              <?><?><?><?> <?><?> copyright <#confval-copyright>).

       -v VERSION
              <?><?><?><?> <?><?><?><?><?>. (<?><?><?><?> <?><?><?><?> <?><?>
              version <#confval-version>).

       -r RELEASE, --release=RELEASE
              <?><?><?><?><?> <?><?><?><?><?><?> (Release) <?><?><?><?><?>.
              (<?><?><?><?> <?><?><?><?> <?><?> release <#confval-release>).

       -l LANGUAGE, --language=LANGUAGE
              <?><?><?><?> <?><?><?><?><?><?><?>. (<?><?><?><?> <?><?><?><?>
              <?><?> language <#confval-language>).

       --suffix=SUFFIX
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>.
              (<?><?><?><?> <?><?><?><?> <?><?> source_suffix <#confval-
              source_suffix>).

       --master=MASTER
              <?><?><?> <?><?><?> <?><?><?><?> (Master). (<?><?><?><?>
              <?><?><?><?> <?><?> root_doc <#confval-root_doc>).

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>

       --ext-autodoc
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.autodoc <#module-sphinx.ext.autodoc>.

       --ext-doctest
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.doctest.

       --ext-intersphinx
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.intersphinx.

       --ext-todo
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> sphinx.ext.todo.

       --ext-coverage
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.coverage.

       --ext-imgmath
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.imgmath.

       --ext-mathjax
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.mathjax.

       --ext-ifconfig
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.ifconfig.

       --ext-viewcode
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.viewcode.

       --ext-githubpages
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              sphinx.ext.githubpages.

       --extensions=EXTENSIONS
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?>.

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> Makefile <?> Batchfile

       --use-make-mode (-m), --no-use-make-mode (-M)
              <?><?><?><?><?> <?><?><?><?><?><?> <?><?> Makefile/make.bat
              <?><?> make-mode <#make-mode> <?><?><?><?><?><?><?> <?><?><?>
              (<?><?> <?><?><?><?>).  <?><?><?><?><?><?><?> use <?><?><?>
              <?><?> <?><?> Makefile/make.bat <?><?><?><?><?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?>.

              <?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> 1.5:
              <?><?><?><?> make-mode <?><?><?><?><?><?><?> <?><?>.


              <?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> 7.3:
              <?><?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?><?><?><?><?> make-mode <?><?> Sphinx 8
              <?><?><?> <?><?><?><?><?> <?><?>.


              <?><?><?> <?><?><?> <?><?> <?><?><?><?> 8.0: <?><?><?><?><?>
              --no-use-make-mode <?><?><?> <?><?>.  <?><?><?><?><?>
              --use-make-mode <?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>.


       --makefile, --no-makefile
              <?><?><?><?><?> (<?><?> <?><?><?> <?><?><?><?><?>) makefile.

       --batchfile, --no-batchfile
              <?><?><?><?><?> (<?><?> <?><?><?> <?><?><?><?><?>) batchfile.

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>

       <?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?> 1.5:
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> sphinx-quickstart


       -t, --templatedir=TEMPLATEDIR
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?>. <?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?> sphinx <?><?><?><?><?>
              <?><?><?> <?><?><?><?> quickstart <?><?> <?><?><?><?><?>
              <?><?><?><?>. <?><?><?><?><?><?><?><?> <?><?><?><?> Jinja2
              <?><?><?> <?><?><?><?> <?><?><?><?><?>:

              o root_doc.rst.jinja

              o conf.py.jinja

              o Makefile.jinja

              o Makefile.new.jinja

              o make.bat.jinja

              o make.bat.new.jinja

              <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?> <?><?> Sphinx <?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>.
              (sphinx/templates/quickstart)

       -d NAME=VALUE
              <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?>

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       sphinx-build(1)

<?><?><?><?><?><?><?><?> <?> <?><?><?><?><?> (COPYRIGHT)
       2007-2026, the Sphinx developers

9.1.0                            March 4, 2026            SPHINX-QUICKSTART(1)