build_docs.main

Full path: schola.scripts.utils.build_docs.main

schola.scripts.utils.build_docs.main

main

main(
    plugin_folder=WindowsPath("."),
    doxygen=True,
    builder="html",
    build_dir=None,
    clean=False,
    sphinx_opts="",
    verbose=False,
)

Build the documentation for the Schola plugin.

Parameters

plugin_folder (Path) : Path to the root of the Schola plugin (defaults to current directory).

doxygen (bool) : If False, skip running Doxygen.

builder (str) : Sphinx builder to use, e.g. ‘html’, ‘dirhtml’, ‘json’, etc.

build_dir (Optional[Path]) : Override output build directory. If not set, defaults to <plugin_folder>/Docs/Sphinx/_build/<builder>

clean (bool) : If True, remove the build_dir before building.

sphinx_opts (str) : Extra options forwarded to sphinx-build (string will be split).

verbose (bool) : Increase logging level.

---