recon_gen.main

mkdocs-macros entry point.

mkdocs-macros loads the module named in mkdocs.yml plugins: module_name: recon_gen.main. We register:

• A diagram(family, **kwargs) macro that dispatches to the render functions in recon_gen.common.handbook.diagrams.

• A vocab Jinja variable populated from vocabulary_for(l2_instance) so any markdown page can substitute {{ vocab.institution.name }} etc.

Both default to the L2 instance at QS_DOCS_L2_INSTANCE (env var) or the bundled _l2_fixtures/spec_example.yaml if unset. docs export lets the integrator pass an arbitrary L2 path.

Pre-restructure (v8.5.x and earlier) this module lived as a top-level main.py and resolved fixtures relative to the repo root. The restructure ships it inside the package so docs apply works from an installed wheel — fixtures now ship in _l2_fixtures/ next to the package’s other resources.

Functions

define_env(env)

mkdocs-macros entry point.

recon_gen.main.define_env(env)

mkdocs-macros entry point.

env is the MacroEnvironment; env.macro(fn) registers a callable accessible from any markdown page as {{ fn(...) }}; env.variables[k] = v exposes v as {{ k }}.

Return type:

None

Parameters:

env (Any)