1SPHINX-AUTOBUILD(1)              User Commands             SPHINX-AUTOBUILD(1)
2
3
4

NAME

6       sphinx-autobuild - manual page for sphinx-autobuild 2021.03.14
7

DESCRIPTION

9       usage: sphinx-autobuild [-h] [--port PORT] [--host HOST]
10
11       [--re-ignore RE_IGNORE] [--ignore IGNORE]
12              [--no-initial]  [--open-browser]  [--delay  DELAY] [--watch DIR]
13              [--pre-build COMMAND] [--version]  sourcedir  outdir  [filenames
14              ...]
15
16   positional arguments:
17       sourcedir
18              source directory
19
20       outdir output directory for built documentation
21
22       filenames
23              specific files to rebuild on each run (default: None)
24
25   options:
26       -h, --help
27              show this help message and exit
28
29       --port PORT
30              port to serve documentation on. 0 means find and use a free port
31              (default: 8000)
32
33       --host HOST
34              hostname to serve documentation on (default: 127.0.0.1)
35
36       --re-ignore RE_IGNORE
37              regular expression  for  files  to  ignore,  when  watching  for
38              changes (default: [])
39
40       --ignore IGNORE
41              glob  expression  for files to ignore, when watching for changes
42              (default: [])
43
44       --no-initial
45              skip the initial build (default: False)
46
47       --open-browser
48              open the browser after building documentation (default: False)
49
50       --delay DELAY
51              how long to wait before opening the browser (default: 5)
52
53       --watch DIR
54              additional directories to watch (default: [])
55
56       --pre-build COMMAND
57              additional command(s) to run prior to building the documentation
58              (default: [])
59
60       --version
61              show program's version number and exit
62
63   sphinx's arguments:
64              The  following  arguments  are forwarded as-is to Sphinx. Please
65              look at `sphinx --help` for more information.
66
67       -b=builder, -a,  -E,  -d=path,  -j=N,  -c=path,  -C,  -D=setting=value,
68              -t=tag, -A=name=value, -n, -v, -q, -Q, -w=file, -W, -T, -N, -P
69
70
71
72sphinx-autobuild 2021.03.14        July 2022               SPHINX-AUTOBUILD(1)
Impressum