sphinx-autobuild - Man Page

path to documentation source files

path to output directory

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

show this help message and exit

show program's version number and exit

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)

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

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

use no config file at all, only -D options

override a setting in configuration file

pass a value into HTML templates

define tag: include "only" blocks with TAG

nit-picky mode, warn about all missing references

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)

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

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

hostname to serve documentation on

regular expression for files to ignore, when watching for changes

glob expression for files to ignore, when watching for changes

skip the initial build

open the browser after building documentation

how long to wait before opening the browser

additional directories to watch

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