{
    "content": [
        {
            "type": "text",
            "text": "# sphinx-quickstart(1) (man)\n\n**Summary:** sphinx-quickstart - Sphinx documentation template generator\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -q | --quiet | — | Quiet mode that skips the interactive wizard for specifying options. This option re‐ quires -p, -a and -v options. |\n| -h | --version | — | Display usage summary or Sphinx version. Structure Options --sep If specified, separate source and build directories. |\n| — | --no-sep | — | If specified, create build directory under source directory. |\n| — | --dot | DOT | Inside the root directory, two more directories will be created; \"templates\" for cus‐ tom HTML templates and \"static\" fo |\n| -p | --project | PROJECT | Project name will be set. (see project). |\n| -a | --author | AUTHOR | Author names. (see copyright). |\n| -v | — | VERSION | Version of project. (see version). |\n| -r | --release | RELEASE | Release of project. (see release). |\n| -l | --language | LANGUAGE | Document language. (see language). |\n| — | --suffix | SUFFIX | Source file suffix. (see sourcesuffix). |\n| — | --master | MASTER | Master document name. (see rootdoc). Extension Options |\n| — | --ext-autodoc | — | Enable sphinx.ext.autodoc extension. |\n| — | --ext-doctest | — | Enable sphinx.ext.doctest extension. |\n| — | --ext-intersphinx | — | Enable sphinx.ext.intersphinx extension. |\n| — | --ext-todo | — | Enable sphinx.ext.todo extension. |\n| — | --ext-coverage | — | Enable sphinx.ext.coverage extension. |\n| — | --ext-imgmath | — | Enable sphinx.ext.imgmath extension. |\n| — | --ext-mathjax | — | Enable sphinx.ext.mathjax extension. |\n| — | --ext-ifconfig | — | Enable sphinx.ext.ifconfig extension. |\n| — | --ext-viewcode | — | Enable sphinx.ext.viewcode extension. |\n| — | --ext-githubpages | — | Enable sphinx.ext.githubpages extension. |\n| — | --extensions | EXTENSIONS | Enable arbitrary extensions. Makefile and Batchfile Creation Options |\n| — | --no-use-make-mode | — | Makefile/make.bat uses (or doesn't use) make-mode. Default is use, which generates a more concise Makefile/make.bat. Cha |\n| — | --no-makefile | — | Create (or not create) makefile. |\n| — | --no-batchfile | — | Create (or not create) batchfile Project templating New in version 1.5: Project templating options for sphinx-quickstart |\n| -t | --templatedir | TEMPLATEDIR | Template directory for template files. You can modify the templates of sphinx project files generated by quickstart. Fol |\n| -d | — | — | Define a template variable |\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (1 lines) — 1 subsections\n  - sphinx-quickstart (1 lines)\n- **DESCRIPTION** (4 lines)\n- **OPTIONS** (1 lines) — 27 subsections\n  - -q, --quiet (3 lines)\n  - -h, --help, --version (6 lines)\n  - --no-sep (2 lines)\n  - --dot=DOT (6 lines)\n  - -p PROJECT, --project=PROJECT (2 lines)\n  - -a AUTHOR, --author=AUTHOR (2 lines)\n  - -v VERSION (2 lines)\n  - -r RELEASE, --release=RELEASE (2 lines)\n  - -l LANGUAGE, --language=LANGUAGE (2 lines)\n  - --suffix=SUFFIX (2 lines)\n  - --master=MASTER (4 lines)\n  - --ext-autodoc (2 lines)\n  - --ext-doctest (2 lines)\n  - --ext-intersphinx (2 lines)\n  - --ext-todo (2 lines)\n  - --ext-coverage (2 lines)\n  - --ext-imgmath (2 lines)\n  - --ext-mathjax (2 lines)\n  - --ext-ifconfig (2 lines)\n  - --ext-viewcode (2 lines)\n  - --ext-githubpages (2 lines)\n  - --extensions=EXTENSIONS (4 lines)\n  - --use-make-mode (-m), --no-use-make-mode (-M) (6 lines)\n  - --makefile, --no-makefile (2 lines)\n  - --batchfile, --no-batchfile (7 lines)\n  - -t, --templatedir=TEMPLATEDIR (18 lines)\n  - -d NAME=VALUE (2 lines)\n- **SEE ALSO** (1 lines) — 1 subsections\n  - sphinx-build(1) (1 lines)\n- **COPYRIGHT** (6 lines)\n\n## Full Content\n\n### NAME\n\nsphinx-quickstart - Sphinx documentation template generator\n\n### SYNOPSIS\n\n#### sphinx-quickstart\n\n### DESCRIPTION\n\nsphinx-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\n### OPTIONS\n\n#### -q, --quiet\n\nQuiet  mode that skips the interactive wizard for specifying options.  This option re‐\nquires -p, -a and -v options.\n\n#### -h, --help, --version\n\nDisplay usage summary or Sphinx version.\n\nStructure Options\n\n--sep  If specified, separate source and build directories.\n\n#### --no-sep\n\nIf specified, create build directory under source directory.\n\n#### --dot=DOT\n\nInside 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\n#### -p PROJECT, --project=PROJECT\n\nProject name will be set. (see project).\n\n#### -a AUTHOR, --author=AUTHOR\n\nAuthor names. (see copyright).\n\n#### -v VERSION\n\nVersion of project. (see version).\n\n#### -r RELEASE, --release=RELEASE\n\nRelease of project. (see release).\n\n#### -l LANGUAGE, --language=LANGUAGE\n\nDocument language. (see language).\n\n#### --suffix=SUFFIX\n\nSource file suffix. (see sourcesuffix).\n\n#### --master=MASTER\n\nMaster document name. (see rootdoc).\n\nExtension Options\n\n#### --ext-autodoc\n\nEnable sphinx.ext.autodoc extension.\n\n#### --ext-doctest\n\nEnable sphinx.ext.doctest extension.\n\n#### --ext-intersphinx\n\nEnable sphinx.ext.intersphinx extension.\n\n#### --ext-todo\n\nEnable sphinx.ext.todo extension.\n\n#### --ext-coverage\n\nEnable sphinx.ext.coverage extension.\n\n#### --ext-imgmath\n\nEnable sphinx.ext.imgmath extension.\n\n#### --ext-mathjax\n\nEnable sphinx.ext.mathjax extension.\n\n#### --ext-ifconfig\n\nEnable sphinx.ext.ifconfig extension.\n\n#### --ext-viewcode\n\nEnable sphinx.ext.viewcode extension.\n\n#### --ext-githubpages\n\nEnable sphinx.ext.githubpages extension.\n\n#### --extensions=EXTENSIONS\n\nEnable arbitrary extensions.\n\nMakefile and Batchfile Creation Options\n\n#### --use-make-mode (-m), --no-use-make-mode (-M)\n\nMakefile/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#### --makefile, --no-makefile\n\nCreate (or not create) makefile.\n\n#### --batchfile, --no-batchfile\n\nCreate (or not create) batchfile\n\nProject templating\n\nNew in version 1.5: Project templating options for sphinx-quickstart\n\n#### -t, --templatedir=TEMPLATEDIR\n\nTemplate 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\n#### -d NAME=VALUE\n\nDefine a template variable\n\n### SEE ALSO\n\n#### sphinx-build(1)\n\n### COPYRIGHT\n\n2007-2021, Georg Brandl and the Sphinx team\n\n\n\n\n4.3.2                                       Dec 19, 2021                        SPHINX-QUICKSTART(1)\n\n"
        }
    ],
    "structuredContent": {
        "command": "sphinx-quickstart",
        "section": "1",
        "mode": "man",
        "summary": "sphinx-quickstart - Sphinx documentation template generator",
        "synopsis": "",
        "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": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "sphinx-quickstart",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "DESCRIPTION",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-q, --quiet",
                        "lines": 3,
                        "flag": "-q",
                        "long": "--quiet"
                    },
                    {
                        "name": "-h, --help, --version",
                        "lines": 6,
                        "flag": "-h",
                        "long": "--version"
                    },
                    {
                        "name": "--no-sep",
                        "lines": 2,
                        "long": "--no-sep"
                    },
                    {
                        "name": "--dot=DOT",
                        "lines": 6,
                        "long": "--dot",
                        "arg": "DOT"
                    },
                    {
                        "name": "-p PROJECT, --project=PROJECT",
                        "lines": 2,
                        "flag": "-p",
                        "long": "--project",
                        "arg": "PROJECT"
                    },
                    {
                        "name": "-a AUTHOR, --author=AUTHOR",
                        "lines": 2,
                        "flag": "-a",
                        "long": "--author",
                        "arg": "AUTHOR"
                    },
                    {
                        "name": "-v VERSION",
                        "lines": 2,
                        "flag": "-v",
                        "arg": "VERSION"
                    },
                    {
                        "name": "-r RELEASE, --release=RELEASE",
                        "lines": 2,
                        "flag": "-r",
                        "long": "--release",
                        "arg": "RELEASE"
                    },
                    {
                        "name": "-l LANGUAGE, --language=LANGUAGE",
                        "lines": 2,
                        "flag": "-l",
                        "long": "--language",
                        "arg": "LANGUAGE"
                    },
                    {
                        "name": "--suffix=SUFFIX",
                        "lines": 2,
                        "long": "--suffix",
                        "arg": "SUFFIX"
                    },
                    {
                        "name": "--master=MASTER",
                        "lines": 4,
                        "long": "--master",
                        "arg": "MASTER"
                    },
                    {
                        "name": "--ext-autodoc",
                        "lines": 2,
                        "long": "--ext-autodoc"
                    },
                    {
                        "name": "--ext-doctest",
                        "lines": 2,
                        "long": "--ext-doctest"
                    },
                    {
                        "name": "--ext-intersphinx",
                        "lines": 2,
                        "long": "--ext-intersphinx"
                    },
                    {
                        "name": "--ext-todo",
                        "lines": 2,
                        "long": "--ext-todo"
                    },
                    {
                        "name": "--ext-coverage",
                        "lines": 2,
                        "long": "--ext-coverage"
                    },
                    {
                        "name": "--ext-imgmath",
                        "lines": 2,
                        "long": "--ext-imgmath"
                    },
                    {
                        "name": "--ext-mathjax",
                        "lines": 2,
                        "long": "--ext-mathjax"
                    },
                    {
                        "name": "--ext-ifconfig",
                        "lines": 2,
                        "long": "--ext-ifconfig"
                    },
                    {
                        "name": "--ext-viewcode",
                        "lines": 2,
                        "long": "--ext-viewcode"
                    },
                    {
                        "name": "--ext-githubpages",
                        "lines": 2,
                        "long": "--ext-githubpages"
                    },
                    {
                        "name": "--extensions=EXTENSIONS",
                        "lines": 4,
                        "long": "--extensions",
                        "arg": "EXTENSIONS"
                    },
                    {
                        "name": "--use-make-mode (-m), --no-use-make-mode (-M)",
                        "lines": 6,
                        "long": "--no-use-make-mode"
                    },
                    {
                        "name": "--makefile, --no-makefile",
                        "lines": 2,
                        "long": "--no-makefile"
                    },
                    {
                        "name": "--batchfile, --no-batchfile",
                        "lines": 7,
                        "long": "--no-batchfile"
                    },
                    {
                        "name": "-t, --templatedir=TEMPLATEDIR",
                        "lines": 18,
                        "flag": "-t",
                        "long": "--templatedir",
                        "arg": "TEMPLATEDIR"
                    },
                    {
                        "name": "-d NAME=VALUE",
                        "lines": 2,
                        "flag": "-d"
                    }
                ]
            },
            {
                "name": "SEE ALSO",
                "lines": 1,
                "subsections": [
                    {
                        "name": "sphinx-build(1)",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "COPYRIGHT",
                "lines": 6,
                "subsections": []
            }
        ]
    }
}