{
    "mode": "man",
    "parameter": "sphinx-quickstart",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/sphinx-quickstart/1/json",
    "generated": "2026-05-30T06:05:43Z",
    "synopsis": "",
    "sections": {
        "NAME": {
            "content": "sphinx-quickstart - Sphinx documentation template generator\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "",
            "subsections": [
                {
                    "name": "sphinx-quickstart",
                    "content": ""
                }
            ]
        },
        "DESCRIPTION": {
            "content": "sphinx-quickstart is an interactive tool that asks some questions about your project and then\ngenerates  a  complete  documentation  directory  and  sample  Makefile  to  be   used   with\nsphinx-build(1).\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "-q, --quiet",
                    "content": "Quiet  mode that skips the interactive wizard for specifying options.  This option re‐\nquires -p, -a and -v options.\n",
                    "flag": "-q",
                    "long": "--quiet"
                },
                {
                    "name": "-h, --help, --version",
                    "content": "Display usage summary or Sphinx version.\n\nStructure Options\n\n--sep  If specified, separate source and build directories.\n",
                    "flag": "-h",
                    "long": "--version"
                },
                {
                    "name": "--no-sep",
                    "content": "If specified, create build directory under source directory.\n",
                    "long": "--no-sep"
                },
                {
                    "name": "--dot=DOT",
                    "content": "Inside the root directory, two more directories will be created; \"templates\" for cus‐\ntom  HTML  templates  and \"static\" for custom stylesheets and other static files. You\ncan enter another prefix (such as \".\") to replace the underscore.\n\nProject Basic Options\n",
                    "long": "--dot",
                    "arg": "DOT"
                },
                {
                    "name": "-p PROJECT, --project=PROJECT",
                    "content": "Project name will be set. (see project).\n",
                    "flag": "-p",
                    "long": "--project",
                    "arg": "PROJECT"
                },
                {
                    "name": "-a AUTHOR, --author=AUTHOR",
                    "content": "Author names. (see copyright).\n",
                    "flag": "-a",
                    "long": "--author",
                    "arg": "AUTHOR"
                },
                {
                    "name": "-v VERSION",
                    "content": "Version of project. (see version).\n",
                    "flag": "-v",
                    "arg": "VERSION"
                },
                {
                    "name": "-r RELEASE, --release=RELEASE",
                    "content": "Release of project. (see release).\n",
                    "flag": "-r",
                    "long": "--release",
                    "arg": "RELEASE"
                },
                {
                    "name": "-l LANGUAGE, --language=LANGUAGE",
                    "content": "Document language. (see language).\n",
                    "flag": "-l",
                    "long": "--language",
                    "arg": "LANGUAGE"
                },
                {
                    "name": "--suffix=SUFFIX",
                    "content": "Source file suffix. (see sourcesuffix).\n",
                    "long": "--suffix",
                    "arg": "SUFFIX"
                },
                {
                    "name": "--master=MASTER",
                    "content": "Master document name. (see rootdoc).\n\nExtension Options\n",
                    "long": "--master",
                    "arg": "MASTER"
                },
                {
                    "name": "--ext-autodoc",
                    "content": "Enable sphinx.ext.autodoc extension.\n",
                    "long": "--ext-autodoc"
                },
                {
                    "name": "--ext-doctest",
                    "content": "Enable sphinx.ext.doctest extension.\n",
                    "long": "--ext-doctest"
                },
                {
                    "name": "--ext-intersphinx",
                    "content": "Enable sphinx.ext.intersphinx extension.\n",
                    "long": "--ext-intersphinx"
                },
                {
                    "name": "--ext-todo",
                    "content": "Enable sphinx.ext.todo extension.\n",
                    "long": "--ext-todo"
                },
                {
                    "name": "--ext-coverage",
                    "content": "Enable sphinx.ext.coverage extension.\n",
                    "long": "--ext-coverage"
                },
                {
                    "name": "--ext-imgmath",
                    "content": "Enable sphinx.ext.imgmath extension.\n",
                    "long": "--ext-imgmath"
                },
                {
                    "name": "--ext-mathjax",
                    "content": "Enable sphinx.ext.mathjax extension.\n",
                    "long": "--ext-mathjax"
                },
                {
                    "name": "--ext-ifconfig",
                    "content": "Enable sphinx.ext.ifconfig extension.\n",
                    "long": "--ext-ifconfig"
                },
                {
                    "name": "--ext-viewcode",
                    "content": "Enable sphinx.ext.viewcode extension.\n",
                    "long": "--ext-viewcode"
                },
                {
                    "name": "--ext-githubpages",
                    "content": "Enable sphinx.ext.githubpages extension.\n",
                    "long": "--ext-githubpages"
                },
                {
                    "name": "--extensions=EXTENSIONS",
                    "content": "Enable arbitrary extensions.\n\nMakefile and Batchfile Creation Options\n",
                    "long": "--extensions",
                    "arg": "EXTENSIONS"
                },
                {
                    "name": "--use-make-mode (-m), --no-use-make-mode (-M)",
                    "content": "Makefile/make.bat uses (or doesn't use) make-mode.  Default is use, which generates  a\nmore concise Makefile/make.bat.\n\nChanged in version 1.5: make-mode is default.\n\n",
                    "long": "--no-use-make-mode"
                },
                {
                    "name": "--makefile, --no-makefile",
                    "content": "Create (or not create) makefile.\n",
                    "long": "--no-makefile"
                },
                {
                    "name": "--batchfile, --no-batchfile",
                    "content": "Create (or not create) batchfile\n\nProject templating\n\nNew in version 1.5: Project templating options for sphinx-quickstart\n\n",
                    "long": "--no-batchfile"
                },
                {
                    "name": "-t, --templatedir=TEMPLATEDIR",
                    "content": "Template directory for template files.  You can modify the templates of sphinx project\nfiles generated by quickstart.  Following Jinja2 template files are allowed:\n\n• rootdoc.rstt\n\n• conf.pyt\n\n• Makefilet\n\n• Makefile.newt\n\n• make.batt\n\n• make.bat.newt\n\nIn detail, please refer the  system  template  files  Sphinx  provides.   (sphinx/tem‐‐\nplates/quickstart)\n",
                    "flag": "-t",
                    "long": "--templatedir",
                    "arg": "TEMPLATEDIR"
                },
                {
                    "name": "-d NAME=VALUE",
                    "content": "Define a template variable\n",
                    "flag": "-d"
                }
            ]
        },
        "SEE ALSO": {
            "content": "",
            "subsections": [
                {
                    "name": "sphinx-build(1)",
                    "content": ""
                }
            ]
        },
        "COPYRIGHT": {
            "content": "2007-2021, Georg Brandl and the Sphinx team\n\n\n\n\n4.3.2                                       Dec 19, 2021                        SPHINX-QUICKSTART(1)",
            "subsections": []
        }
    },
    "summary": "sphinx-quickstart - Sphinx documentation template generator",
    "flags": [
        {
            "flag": "-q",
            "long": "--quiet",
            "arg": null,
            "description": "Quiet mode that skips the interactive wizard for specifying options. This option re‐ quires -p, -a and -v options."
        },
        {
            "flag": "-h",
            "long": "--version",
            "arg": null,
            "description": "Display usage summary or Sphinx version. Structure Options --sep If specified, separate source and build directories."
        },
        {
            "flag": "",
            "long": "--no-sep",
            "arg": null,
            "description": "If specified, create build directory under source directory."
        },
        {
            "flag": "",
            "long": "--dot",
            "arg": "DOT",
            "description": "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"
        },
        {
            "flag": "-p",
            "long": "--project",
            "arg": "PROJECT",
            "description": "Project name will be set. (see project)."
        },
        {
            "flag": "-a",
            "long": "--author",
            "arg": "AUTHOR",
            "description": "Author names. (see copyright)."
        },
        {
            "flag": "-v",
            "long": null,
            "arg": "VERSION",
            "description": "Version of project. (see version)."
        },
        {
            "flag": "-r",
            "long": "--release",
            "arg": "RELEASE",
            "description": "Release of project. (see release)."
        },
        {
            "flag": "-l",
            "long": "--language",
            "arg": "LANGUAGE",
            "description": "Document language. (see language)."
        },
        {
            "flag": "",
            "long": "--suffix",
            "arg": "SUFFIX",
            "description": "Source file suffix. (see sourcesuffix)."
        },
        {
            "flag": "",
            "long": "--master",
            "arg": "MASTER",
            "description": "Master document name. (see rootdoc). Extension Options"
        },
        {
            "flag": "",
            "long": "--ext-autodoc",
            "arg": null,
            "description": "Enable sphinx.ext.autodoc extension."
        },
        {
            "flag": "",
            "long": "--ext-doctest",
            "arg": null,
            "description": "Enable sphinx.ext.doctest extension."
        },
        {
            "flag": "",
            "long": "--ext-intersphinx",
            "arg": null,
            "description": "Enable sphinx.ext.intersphinx extension."
        },
        {
            "flag": "",
            "long": "--ext-todo",
            "arg": null,
            "description": "Enable sphinx.ext.todo extension."
        },
        {
            "flag": "",
            "long": "--ext-coverage",
            "arg": null,
            "description": "Enable sphinx.ext.coverage extension."
        },
        {
            "flag": "",
            "long": "--ext-imgmath",
            "arg": null,
            "description": "Enable sphinx.ext.imgmath extension."
        },
        {
            "flag": "",
            "long": "--ext-mathjax",
            "arg": null,
            "description": "Enable sphinx.ext.mathjax extension."
        },
        {
            "flag": "",
            "long": "--ext-ifconfig",
            "arg": null,
            "description": "Enable sphinx.ext.ifconfig extension."
        },
        {
            "flag": "",
            "long": "--ext-viewcode",
            "arg": null,
            "description": "Enable sphinx.ext.viewcode extension."
        },
        {
            "flag": "",
            "long": "--ext-githubpages",
            "arg": null,
            "description": "Enable sphinx.ext.githubpages extension."
        },
        {
            "flag": "",
            "long": "--extensions",
            "arg": "EXTENSIONS",
            "description": "Enable arbitrary extensions. Makefile and Batchfile Creation Options"
        },
        {
            "flag": "",
            "long": "--no-use-make-mode",
            "arg": null,
            "description": "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."
        },
        {
            "flag": "",
            "long": "--no-makefile",
            "arg": null,
            "description": "Create (or not create) makefile."
        },
        {
            "flag": "",
            "long": "--no-batchfile",
            "arg": null,
            "description": "Create (or not create) batchfile Project templating New in version 1.5: Project templating options for sphinx-quickstart"
        },
        {
            "flag": "-t",
            "long": "--templatedir",
            "arg": "TEMPLATEDIR",
            "description": "Template directory for template files. You can modify the templates of sphinx project files generated by quickstart. Following Jinja2 template files are allowed: • rootdoc.rstt • conf.pyt • Makefilet • Makefile.newt • make.batt • make.bat.newt In detail, please refer the system template files Sphinx provides. (sphinx/tem‐‐ plates/quickstart)"
        },
        {
            "flag": "-d",
            "long": null,
            "arg": null,
            "description": "Define a template variable"
        }
    ],
    "examples": [],
    "see_also": []
}