Command Line interface¶
teachbooks¶
TeachBooks command line tools
teachbooks [OPTIONS] COMMAND [ARGS]...
build¶
Pre-process book contents and run Jupyter Book build command
teachbooks build [OPTIONS] PATH_SOURCE
Options
- --release¶
Target release version of the book
- --publish¶
(Deprecated) Use –release instead
- --process-only¶
Only pre-process content
Arguments
- PATH_SOURCE¶
Required argument
clean¶
Stop teachbooks server and run Jupyter Book clean command.
teachbooks clean [OPTIONS] PATH_SOURCE
Arguments
- PATH_SOURCE¶
Required argument
serve¶
Start a web server to interact with the book locally
teachbooks serve [OPTIONS] COMMAND [ARGS]...
stop¶
Stop the webserver
teachbooks serve stop [OPTIONS]