utils.build_docs

Full path: schola.scripts.utils.build_docs

schola.scripts.utils.build_docs

Utility to build documentation for Schola using Doxygen, Breathe (breathe-apidoc) and Sphinx.

• Usage examples:: - Full run (doxygen -> breathe -> sphinx html):: python -m schola.scripts.utils.build_docs –plugin-folder .

• Only Sphinx (skip doxygen/breathe):: python -m schola.scripts.utils.build_docs –no-doxygen –no-breathe-apidoc

• Clean build with extra Sphinx options:: python -m schola.scripts.utils.build_docs –clean –sphinx-opts=”-W -q”

This script mirrors the CLI style used elsewhere in this repository (see compile_proto.py) and uses cyclopts for argument handling.

Functions

Item	Description
main([plugin_folder, doxygen, builder, …])	Build the documentation for the Schola plugin.

• schola.scripts.utils.build_docs.main
• main()