Skip to content

Docs

docs_build(verbose=False)

Builds the documentation using mkdocs.

Source code in cli/docs.py 
16
17
18
19
20
21
22
23
def docs_build(verbose: bool = False):
    """
    Builds the documentation using mkdocs.
    """
    cmds: list[str] = ["mkdocs", "build"]
    if verbose:
        cmds += ["-v"]
    subprocess.run(cmds)

docs_serve(host='0.0.0.0', port='8002', verbose=False)

Serves the documentation locally using mkdocs.

Source code in cli/docs.py 
 5
 6
 7
 8
 9
10
11
12
13
def docs_serve(host: str = "0.0.0.0", port: str = "8002", verbose: bool = False):
    """
    Serves the documentation locally using mkdocs.
    """
    cmds: list[str] = ["mkdocs", "serve"]
    cmds += ["-a", f"{host}:{port}"]
    if verbose:
        cmds += ["-v"]
    subprocess.run(cmds)