SPHINX-BUILD(1) Sphinx SPHINX-BUILD(1) (NAME) sphinx-build - Sphinx (SYNOPSIS) sphinx-build [options] [filenames ...] (DESCRIPTION) sphinx-build . sphinx-build /conf.py . sphinx-quickstart(1) conf.py . sphinx-build . (builder) HTML . . Builders <> . . . (OPTIONS) -M buildername make-mode . Sphinx Builders <> . . : Sphinx -M . : sphinx-build -M html ./source ./build --fail-on-warning make-mode Makefile Make.bat : latexpdf LaTeX pdflatex latex_engine <#confval- latex_engine> . language <#confval-language> 'ja' LaTeX PDF platex/dvipdfmx . info Texinfo makeinfo . help . : make-mode -b . o (doctrees) /doctrees o / 1.2.1 . -b buildername, --builder buildername . Sphinx Builders <> . . 7.3: --builder. -a, --write-all . . ( .) : . --fresh-env . 7.3: --write-all. -E, --fresh-env <#term- environment> ( ) . . 7.3: --fresh-env. -t tag, --tag tag tag . only <#directive- only> . <# tags> . 0.6 . 7.3: --tag. -d path, --doctree-dir path Sphinx "doctree pickles" . .doctrees (doctree ). 7.3: --doctree-dir. -j N, --jobs N N . "fork" Windows . Sphinx . auto Sphinx (CPU) N . 1 . 1.2 : (experimental) . 1.7: auto. 6.2: --jobs. -c path, --conf-dir path conf.py . . 0.3 . 7.3: --conf-dir. -C, --isolated --define . 0.5 . 7.3 : --isolated . -D setting=value, --define setting=value conf.py. . : -D html_theme_path=path1,path2. : -D latex_elements.docclass=scrartcl. 0 1 . 0.6 : . 1.3 : . 7.3 : --define . -A name=value, --html-define name=value value name HTML. 0.5 . 7.3 : --html-define . -n, --nitpicky (nitpicky). . " " nitpick_ignore <#confval-nitpick_ignore> . 7.3 : --nitpicky . -N, --no-color . 1.6 : --no-color . --color . . 1.6 . -v, --verbose ( ). . -T . 1.2 . 7.3 : --verbose . -q, --quiet . 7.3 : --quiet . -Q, --silent . . 7.3 : --silent . -w file, --warning-file file ( ) . 7.3 : ANSI file . 7.3 : --warning-file . -W, --fail-on-warning . sphinx-build 1 . 7.3 : --fail-on-warning . 8.1 : sphinx-build 1 . --keep-going . --keep-going Sphinx 8.1 --keep-going . --fail-on-warning sphinx-build . --keep-going sphinx-build 1 . 1.8 . 8.1 : sphinx-build --keep-going . . -T, --show-traceback traceback . traceback . 1.2 . 7.3 : --show-traceback . -P, --pdb ( .) pdb . 7.3 : --pdb . --exception-on-warning . --pdb . 8.1 . -h, --help, --version Sphinx. 1.2 . . Sphinx ( ) ..SH " (ENVIRONMENT VARIABLES)" sphinx-build : MAKE make. . sphinx-build make-mode . Makefile Makefile make.bat sphinx-quickstart sphinx-build -b -d . : PAPER 'papersize' latex_elements <#confval-latex_elements> : PAPER=a4 'a4paper' PAPER=letter 'letterpaper' . : Sphinx 1.5 a4 letter a4paper letterpaper LaTeX . 1.7.7 . SPHINXBUILD sphinx-build . BUILDDIR sphinx-quickstart . SPHINXOPTS sphinx-build. O ( 'o') . NO_COLOR ( ) sphinx-build . NO_COLOR FORCE_COLOR . no-color.org . 4.5.0. FORCE_COLOR ( ) sphinx-build . NO_COLOR FORCE_COLOR . 4.5.0. (DEPRECATION WARNINGS) RemovedInSphinxXXXWarning Sphinx . . PYTHONWARNINGS= . : o PYTHONWARNINGS= make html ( Linux/Mac) o export PYTHONWARNINGS= make html ( Linux/Mac) o set PYTHONWARNINGS= make html ( Windows) o Makefile/make.bat (SEE ALSO) sphinx-quickstart(1) (COPYRIGHT) 2007-2026 Sphinx 9.1.0 March 4, 2026 SPHINX-BUILD(1)