{ "content": [ { "type": "text", "text": "# sphinx-build(1) (man)\n\n**Summary:** sphinx-build - Sphinx documentation generator tool\n\n**Synopsis:** sphinx-build [options] [filenames ...]\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -b | — | — | The most important option: it selects a builder. The most common builders are: html Build HTML pages. This is the defaul |\n| -M | — | — | Alternative to -b. Uses the Sphinx makemode module, which provides the same build functionality as a default Makefile or |\n| -a | — | — | new and changed source files. (This may not apply to all builders.) |\n| -E | — | — | build it completely. The default is to only read and parse source files that are new or have changed since the last run. |\n| -t | — | — | tent if this tag is set. New in version 0.6. |\n| -d | — | — | Since Sphinx has to read and parse all source files before it can write an output file, the parsed source files are cach |\n| -j | — | — | machines more effective. Note that not all parts and not all builders of Sphinx can be parallelized. If auto argument is |\n| -c | — | — | Don't look for the conf.py in the source directory, but use the given configuration directory instead. Note that various |\n| -D | — | — | New in version 0.5. |\n| -D | — | — | Override a configuration value set in the conf.py file. The value must be a number, string, list or dictionary value. Fo |\n| -A | — | — | Make the name assigned to value in the HTML templates. New in version 0.5. |\n| -n | — | — | See the config value nitpickignore for a way to exclude some references as \"known missing\". |\n| -N | — | — | |\n| -v | — | — | debug logging output. It implies -T. New in version 1.2. |\n| -q | — | — | error. |\n| -Q | — | — | written to standard error. |\n| -w | — | — | Write warnings (and errors) to the given file, in addition to standard error. |\n| -W | — | — | sphinx-build exits with exit status 1. |\n| — | --keep-going | — | With -W option, keep going processing when getting warnings to the end of build, and sphinx-build exits with exit status |\n| -T | — | — | mary is displayed and the traceback information is saved to a file for further analy‐ sis. New in version 1.2. |\n| -P | — | — | occurs while building. |\n| -h | --version | — | Display usage summary or Sphinx version. New in version 1.2. You can also give one or more filenames on the command line |\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (2 lines)\n- **DESCRIPTION** (14 lines)\n- **OPTIONS** (1 lines) — 22 subsections\n - -b buildername (46 lines)\n - -M buildername (17 lines)\n - -a (2 lines)\n - -E (3 lines)\n - -t (5 lines)\n - -d path (6 lines)\n - -j (9 lines)\n - -c path (8 lines)\n - -C -D (3 lines)\n - -D setting=value (17 lines)\n - -A name=value (5 lines)\n - -n (3 lines)\n - -N (1 lines)\n - -v (5 lines)\n - -q (2 lines)\n - -Q (2 lines)\n - -w file (2 lines)\n - -W (2 lines)\n - --keep-going (6 lines)\n - -T (6 lines)\n - -P (2 lines)\n - -h, --help, --version (8 lines)\n- **ENVIRONMENT VARIABLES** (29 lines)\n- **DEPRECATION WARNINGS** (15 lines)\n- **SEE ALSO** (1 lines) — 1 subsections\n - sphinx-quickstart(1) (1 lines)\n- **COPYRIGHT** (6 lines)\n\n## Full Content\n\n### NAME\n\nsphinx-build - Sphinx documentation generator tool\n\n### SYNOPSIS\n\nsphinx-build [options] [filenames ...]\n\n### DESCRIPTION\n\nsphinx-build generates documentation from the files in and places it in the .\n\nsphinx-build looks for /conf.py for the configuration settings. sphinx-quick‐‐\nstart(1) may be used to generate template files, including conf.py.\n\nsphinx-build can create documentation in different formats. A format is selected by specify‐\ning the builder name on the command line; it defaults to HTML. Builders can also perform\nother tasks related to documentation processing. For a list of available builders, refer to\nsphinx-build -b.\n\nBy default, everything that is outdated is built. Output only for selected files can be\nbuilt by specifying individual filenames.\n\n### OPTIONS\n\n#### -b buildername\n\nThe most important option: it selects a builder. The most common builders are:\n\nhtml Build HTML pages. This is the default builder.\n\ndirhtml\nBuild HTML pages, but with a single directory per document. Makes for prettier\nURLs (no .html) if served from a webserver.\n\nsinglehtml\nBuild a single HTML with the whole content.\n\nhtmlhelp, qthelp, devhelp, epub\nBuild HTML files with additional information for building a documentation col‐\nlection in one of these formats.\n\napplehelp\nBuild an Apple Help Book. Requires hiutil and codesign, which are not Open\nSource and presently only available on Mac OS X 10.6 and higher.\n\nlatex Build LaTeX sources that can be compiled to a PDF document using pdflatex.\n\nman Build manual pages in groff format for UNIX systems.\n\ntexinfo\nBuild Texinfo files that can be processed into Info files using makeinfo.\n\ntext Build plain text files.\n\ngettext\nBuild gettext-style message catalogs (.pot files).\n\ndoctest\nRun all doctests in the documentation, if the doctest extension is enabled.\n\nlinkcheck\nCheck the integrity of all external links.\n\nxml Build Docutils-native XML files.\n\npseudoxml\nBuild compact pretty-printed \"pseudo-XML\" files displaying the internal struc‐\nture of the intermediate document trees.\n\nSee /usage/builders/index for a list of all builders shipped with Sphinx. Extensions\ncan add their own builders.\n\n#### -M buildername\n\nAlternative to -b. Uses the Sphinx makemode module, which provides the same build\nfunctionality as a default Makefile or Make.bat. In addition to all Sphinx /us‐\nage/builders/index, the following build pipelines are available:\n\nlatexpdf\nBuild LaTeX files and run them through pdflatex, or as per latexengine set‐\nting. If language is set to 'ja', will use automatically the platex/dvipdfmx\nlatex to PDF pipeline.\n\ninfo Build Texinfo files and run them through makeinfo.\n\nIMPORTANT:\nSphinx only recognizes the -M option if it is placed first.\n\nNew in version 1.2.1.\n\n#### -a\n\nnew and changed source files. (This may not apply to all builders.)\n\n#### -E\n\nbuild it completely. The default is to only read and parse source files that are new\nor have changed since the last run.\n\n#### -t\n\ntent if this tag is set.\n\nNew in version 0.6.\n\n#### -d path\n\nSince Sphinx has to read and parse all source files before it can write an output\nfile, the parsed source files are cached as \"doctree pickles\". Normally, these files\nare put in a directory called .doctrees under the build directory; with this option\nyou can select a different cache directory (the doctrees can be shared between all\nbuilders).\n\n#### -j\n\nmachines more effective. Note that not all parts and not all builders of Sphinx can\nbe parallelized. If auto argument is given, Sphinx uses the number of CPUs as N.\n\nNew in version 1.2: This option should be considered experimental.\n\n\nChanged in version 1.7: Support auto argument.\n\n#### -c path\n\nDon't look for the conf.py in the source directory, but use the given configuration\ndirectory instead. Note that various other files and paths given by configuration\nvalues are expected to be relative to the configuration directory, so they will have\nto be present at this location too.\n\nNew in version 0.3.\n\n#### -C -D\n\nNew in version 0.5.\n\n#### -D setting=value\n\nOverride a configuration value set in the conf.py file. The value must be a number,\nstring, list or dictionary value.\n\nFor lists, you can separate elements with a comma like this: -D\nhtmlthemepath=path1,path2.\n\nFor dictionary values, supply the setting name and key like this: -D latexele‐‐\nments.docclass=scrartcl.\n\nFor boolean values, use 0 or 1 as the value.\n\nChanged in version 0.6: The value can now be a dictionary value.\n\n\nChanged in version 1.3: The value can now also be a list value.\n\n#### -A name=value\n\nMake the name assigned to value in the HTML templates.\n\nNew in version 0.5.\n\n#### -n\n\nSee the config value nitpickignore for a way to exclude some references as \"known\nmissing\".\n\n#### -N\n\n#### -v\n\ndebug logging output. It implies -T.\n\nNew in version 1.2.\n\n#### -q\n\nerror.\n\n#### -Q\n\nwritten to standard error.\n\n#### -w file\n\nWrite warnings (and errors) to the given file, in addition to standard error.\n\n#### -W\n\nsphinx-build exits with exit status 1.\n\n#### --keep-going\n\nWith -W option, keep going processing when getting warnings to the end of build, and\nsphinx-build exits with exit status 1.\n\nNew in version 1.8.\n\n#### -T\n\nmary is displayed and the traceback information is saved to a file for further analy‐\nsis.\n\nNew in version 1.2.\n\n#### -P\n\noccurs while building.\n\n#### -h, --help, --version\n\nDisplay usage summary or Sphinx version.\n\nNew in version 1.2.\n\n\nYou can also give one or more filenames on the command line after the source and build direc‐\ntories. Sphinx will then try to build only these output files (and their dependencies).\n\n### ENVIRONMENT VARIABLES\n\nThe sphinx-build refers following environment variables:\n\nMAKE A path to make command. A command name is also allowed. sphinx-build uses it to in‐\nvoke sub-build process on make-mode.\n\nMakefile Options\n\nThe Makefile and make.bat files created by sphinx-quickstart usually run sphinx-build only\nwith the -b and -d options. However, they support the following variables to customize be‐\nhavior:\n\nPAPER This sets the 'papersize' key of latexelements: i.e. PAPER=a4 sets it to 'a4paper'\nand PAPER=letter to 'letterpaper'.\n\nNOTE:\nUsage of this environment variable got broken at Sphinx 1.5 as a4 or letter ended\nup as option to LaTeX document in place of the needed a4paper, resp. letterpaper.\nFixed at 1.7.7.\n\nSPHINXBUILD\nThe command to use instead of sphinx-build.\n\nBUILDDIR\nThe build directory to use instead of the one chosen in sphinx-quickstart.\n\nSPHINXOPTS\nAdditional options for sphinx-build. These options can also be set via the shortcut\nvariable O (capital 'o').\n\n### DEPRECATION WARNINGS\n\nIf any deprecation warning like RemovedInSphinxXXXWarning are displayed when building a\nuser's document, some Sphinx extension is using deprecated features. In that case, please re‐\nport it to author of the extension.\n\nTo disable the deprecation warnings, please set PYTHONWARNINGS= environment variable to your\nenvironment. For example:\n\n• PYTHONWARNINGS= make html (Linux/Mac)\n\n• export PYTHONWARNINGS= and do make html (Linux/Mac)\n\n• set PYTHONWARNINGS= and do make html (Windows)\n\n• modify your Makefile/make.bat and set the environment variable\n\n### SEE ALSO\n\n#### sphinx-quickstart(1)\n\n### COPYRIGHT\n\n2007-2021, Georg Brandl and the Sphinx team\n\n\n\n\n4.3.2 Dec 19, 2021 SPHINX-BUILD(1)\n\n" } ], "structuredContent": { "command": "sphinx-build", "section": "1", "mode": "man", "summary": "sphinx-build - Sphinx documentation generator tool", "synopsis": "sphinx-build [options] [filenames ...]", "flags": [ { "flag": "-b", "long": null, "arg": null, "description": "The most important option: it selects a builder. The most common builders are: html Build HTML pages. This is the default builder. dirhtml Build HTML pages, but with a single directory per document. Makes for prettier URLs (no .html) if served from a webserver. singlehtml Build a single HTML with the whole content. htmlhelp, qthelp, devhelp, epub Build HTML files with additional information for building a documentation col‐ lection in one of these formats. applehelp Build an Apple Help Book. Requires hiutil and codesign, which are not Open Source and presently only available on Mac OS X 10.6 and higher. latex Build LaTeX sources that can be compiled to a PDF document using pdflatex. man Build manual pages in groff format for UNIX systems. texinfo Build Texinfo files that can be processed into Info files using makeinfo. text Build plain text files. gettext Build gettext-style message catalogs (.pot files). doctest Run all doctests in the documentation, if the doctest extension is enabled. linkcheck Check the integrity of all external links. xml Build Docutils-native XML files. pseudoxml Build compact pretty-printed \"pseudo-XML\" files displaying the internal struc‐ ture of the intermediate document trees. See /usage/builders/index for a list of all builders shipped with Sphinx. Extensions can add their own builders." }, { "flag": "-M", "long": null, "arg": null, "description": "Alternative to -b. Uses the Sphinx makemode module, which provides the same build functionality as a default Makefile or Make.bat. In addition to all Sphinx /us‐ age/builders/index, the following build pipelines are available: latexpdf Build LaTeX files and run them through pdflatex, or as per latexengine set‐ ting. If language is set to 'ja', will use automatically the platex/dvipdfmx latex to PDF pipeline. info Build Texinfo files and run them through makeinfo. IMPORTANT: Sphinx only recognizes the -M option if it is placed first. New in version 1.2.1." }, { "flag": "-a", "long": null, "arg": null, "description": "new and changed source files. (This may not apply to all builders.)" }, { "flag": "-E", "long": null, "arg": null, "description": "build it completely. The default is to only read and parse source files that are new or have changed since the last run." }, { "flag": "-t", "long": null, "arg": null, "description": "tent if this tag is set. New in version 0.6." }, { "flag": "-d", "long": null, "arg": null, "description": "Since Sphinx has to read and parse all source files before it can write an output file, the parsed source files are cached as \"doctree pickles\". Normally, these files are put in a directory called .doctrees under the build directory; with this option you can select a different cache directory (the doctrees can be shared between all builders)." }, { "flag": "-j", "long": null, "arg": null, "description": "machines more effective. Note that not all parts and not all builders of Sphinx can be parallelized. If auto argument is given, Sphinx uses the number of CPUs as N. New in version 1.2: This option should be considered experimental. Changed in version 1.7: Support auto argument." }, { "flag": "-c", "long": null, "arg": null, "description": "Don't look for the conf.py in the source directory, but use the given configuration directory instead. Note that various other files and paths given by configuration values are expected to be relative to the configuration directory, so they will have to be present at this location too. New in version 0.3." }, { "flag": "-D", "long": null, "arg": null, "description": "New in version 0.5." }, { "flag": "-D", "long": null, "arg": null, "description": "Override a configuration value set in the conf.py file. The value must be a number, string, list or dictionary value. For lists, you can separate elements with a comma like this: -D htmlthemepath=path1,path2. For dictionary values, supply the setting name and key like this: -D latexele‐‐ ments.docclass=scrartcl. For boolean values, use 0 or 1 as the value. Changed in version 0.6: The value can now be a dictionary value. Changed in version 1.3: The value can now also be a list value." }, { "flag": "-A", "long": null, "arg": null, "description": "Make the name assigned to value in the HTML templates. New in version 0.5." }, { "flag": "-n", "long": null, "arg": null, "description": "See the config value nitpickignore for a way to exclude some references as \"known missing\"." }, { "flag": "-N", "long": null, "arg": null, "description": "" }, { "flag": "-v", "long": null, "arg": null, "description": "debug logging output. It implies -T. New in version 1.2." }, { "flag": "-q", "long": null, "arg": null, "description": "error." }, { "flag": "-Q", "long": null, "arg": null, "description": "written to standard error." }, { "flag": "-w", "long": null, "arg": null, "description": "Write warnings (and errors) to the given file, in addition to standard error." }, { "flag": "-W", "long": null, "arg": null, "description": "sphinx-build exits with exit status 1." }, { "flag": "", "long": "--keep-going", "arg": null, "description": "With -W option, keep going processing when getting warnings to the end of build, and sphinx-build exits with exit status 1. New in version 1.8." }, { "flag": "-T", "long": null, "arg": null, "description": "mary is displayed and the traceback information is saved to a file for further analy‐ sis. New in version 1.2." }, { "flag": "-P", "long": null, "arg": null, "description": "occurs while building." }, { "flag": "-h", "long": "--version", "arg": null, "description": "Display usage summary or Sphinx version. New in version 1.2. You can also give one or more filenames on the command line after the source and build direc‐ tories. Sphinx will then try to build only these output files (and their dependencies)." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 14, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-b buildername", "lines": 46, "flag": "-b" }, { "name": "-M buildername", "lines": 17, "flag": "-M" }, { "name": "-a", "lines": 2, "flag": "-a" }, { "name": "-E", "lines": 3, "flag": "-E" }, { "name": "-t", "lines": 5, "flag": "-t" }, { "name": "-d path", "lines": 6, "flag": "-d" }, { "name": "-j", "lines": 9, "flag": "-j" }, { "name": "-c path", "lines": 8, "flag": "-c" }, { "name": "-C -D", "lines": 3, "flag": "-D" }, { "name": "-D setting=value", "lines": 17, "flag": "-D" }, { "name": "-A name=value", "lines": 5, "flag": "-A" }, { "name": "-n", "lines": 3, "flag": "-n" }, { "name": "-N", "lines": 1, "flag": "-N" }, { "name": "-v", "lines": 5, "flag": "-v" }, { "name": "-q", "lines": 2, "flag": "-q" }, { "name": "-Q", "lines": 2, "flag": "-Q" }, { "name": "-w file", "lines": 2, "flag": "-w" }, { "name": "-W", "lines": 2, "flag": "-W" }, { "name": "--keep-going", "lines": 6, "long": "--keep-going" }, { "name": "-T", "lines": 6, "flag": "-T" }, { "name": "-P", "lines": 2, "flag": "-P" }, { "name": "-h, --help, --version", "lines": 8, "flag": "-h", "long": "--version" } ] }, { "name": "ENVIRONMENT VARIABLES", "lines": 29, "subsections": [] }, { "name": "DEPRECATION WARNINGS", "lines": 15, "subsections": [] }, { "name": "SEE ALSO", "lines": 1, "subsections": [ { "name": "sphinx-quickstart(1)", "lines": 1 } ] }, { "name": "COPYRIGHT", "lines": 6, "subsections": [] } ] } }