Your company here — click to reach over 10,000 unique daily visitors

sphinx-autobuild - Man Page

Autobuild a Sphinx directory when a change is detected


usage: sphinx-autobuild [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]

positional arguments


path to documentation source files


path to output directory


a list of specific files to rebuild. Ignored if -a is specified


-h,  --help

show this help message and exit


show program's version number and exit

general options


builder to use (default: html)


write all files (default: only write new and changed files)


don't use a saved environment, always read all files


path for the cached environment and doctree files (default: OUTPUTDIR/.doctrees)

-j,  --jobs N

build in parallel with N processes where possible (special value "auto" will set N to cpu-count)

build configuration options


path where configuration file (conf.py) is located (default: same as SOURCEDIR)


use no config file at all, only -D options

-D setting=value

override a setting in configuration file

-A name=value

pass a value into HTML templates

-t TAG

define tag: include "only" blocks with TAG


nit-picky mode, warn about all missing references

console output options


increase verbosity (can be repeated)


no output on stdout, just warnings on stderr


no output at all, not even warnings


do emit colored output (default: auto-detect)

-N,  --no-color

do not emit colored output (default: auto-detect)


write warnings (and errors) to given file


turn warnings into errors


with -W, keep going when getting warnings


show full traceback on exception


run Pdb on exception

autobuild options

--port PORT

port to serve documentation on. 0 means find and use a free port

--host HOST

hostname to serve documentation on

--re-ignore RE_IGNORE

regular expression for files to ignore, when watching for changes

--ignore IGNORE

glob expression for files to ignore, when watching for changes


skip the initial build


open the browser after building documentation

--delay DELAY

how long to wait before opening the browser

--watch DIR

additional directories to watch

--pre-build COMMAND

additional command(s) to run prior to building the documentation


June 2024 sphinx-autobuild 2024.04.16