Command Line interface¶
This chapter is under construction.
teachbooks¶
TeachBooks command line tools.
Usage
teachbooks [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
build¶
Pre-process book contents and run Jupyter Book build command.
Usage
teachbooks build [OPTIONS] PATH_SOURCE
Options
- --release¶
Build book with release strategy
- --publish¶
–public is 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.
Usage
teachbooks clean [OPTIONS] PATH_SOURCE
Options
- --external¶
Empty _git/ directory.
Arguments
- PATH_SOURCE¶
Required argument
serve¶
Start a web server to interact with the book locally.
If serve dir path not provided, default is ./book/_build/html. Checks to see if server is already running.
Usage
teachbooks serve [OPTIONS] COMMAND [ARGS]...
Options
- -v, --verbose¶
path¶
Specify relative path of directory to serve.
Usage
teachbooks serve path [OPTIONS] PATH_SOURCE
Options
- -v, --verbose¶
Arguments
- PATH_SOURCE¶
Required argument
stop¶
Stop the webserver.
Usage
teachbooks serve stop [OPTIONS]