OS Manuals

/usr/bin/sphinx-quickstart

Executable binaries for sphinx installed for python3.14

From py3.14-sphinx-bin 9.2.0-r0 (os), captured 2026-11-05 by running sphinx-quickstart --help (exit 0). permalink

usage: sphinx-quickstart [OPTIONS] <PROJECT_DIR>

Generate required files for a Sphinx project. 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.

positional arguments:
  PROJECT_DIR           project root

options:
  -h, --help            show this help message and exit
  -q, --quiet           quiet mode
  --version             show program's version number and exit

Structure options:
  --sep                 if specified, separate source and build dirs
  --no-sep              if specified, create build dir under source dir
  --dot DOT             replacement for dot in _templates etc.

Project basic options:
  -p, --project PROJECT
                        project name
  -a, --author AUTHOR   author names
  -v VERSION            version of project
  -r, --release RELEASE
                        release of project
  -l, --language LANGUAGE
                        document language
  --suffix SUFFIX       source file suffix
  --master MASTER       master document name
  --epub                use epub

Extension options:
  --ext-autodoc         enable autodoc extension
  --ext-doctest         enable doctest extension
  --ext-intersphinx     enable intersphinx extension
  --ext-todo            enable todo extension
  --ext-coverage        enable coverage extension
  --ext-imgmath         enable imgmath extension
  --ext-mathjax         enable mathjax extension
  --ext-ifconfig        enable ifconfig extension
  --ext-viewcode        enable viewcode extension
  --ext-githubpages     enable githubpages extension
  --extensions EXTENSIONS
                        enable arbitrary extensions

Makefile and Batchfile creation:
  --makefile            create makefile
  --no-makefile         do not create makefile
  --batchfile           create batchfile
  --no-batchfile        do not create batchfile
  -m, --use-make-mode   use make-mode for Makefile/make.bat

Project templating:
  -t, --templatedir TEMPLATEDIR
                        template directory for template files
  -d NAME=VALUE         define a template variable

For more information, visit <https://www.sphinx-doc.org/>.
Options (32)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-q, --quietquiet modehelp
--versionshow program's version number and exithelp
--sepif specified, separate source and build dirshelp
--no-sepif specified, create build dir under source dirhelp
--dot DOTreplacement for dot in _templates etc.help
-p, --project PROJECTproject namehelp
-a, --author AUTHORauthor nameshelp
-v VERSIONversion of projecthelp
-r, --release RELEASErelease of projecthelp
-l, --language LANGUAGEdocument languagehelp
--suffix SUFFIXsource file suffixhelp
--master MASTERmaster document namehelp
--epubuse epubhelp
--ext-autodocenable autodoc extensionhelp
--ext-doctestenable doctest extensionhelp
--ext-intersphinxenable intersphinx extensionhelp
--ext-todoenable todo extensionhelp
--ext-coverageenable coverage extensionhelp
--ext-imgmathenable imgmath extensionhelp
--ext-mathjaxenable mathjax extensionhelp
--ext-ifconfigenable ifconfig extensionhelp
--ext-viewcodeenable viewcode extensionhelp
--ext-githubpagesenable githubpages extensionhelp
--extensions EXTENSIONSenable arbitrary extensionshelp
--makefilecreate makefilehelp
--no-makefiledo not create makefilehelp
--batchfilecreate batchfilehelp
--no-batchfiledo not create batchfilehelp
-m, --use-make-modeuse make-mode for Makefile/make.bathelp
-t, --templatedir TEMPLATEDIRtemplate directory for template fileshelp
-d NAME=VALUEdefine a template variablehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.