axiom_graph_render_site

axiom_graph.mcp.server.axiom_graph_render_site(project_root, build=False, nav_path=None, output_dir=None, targets=None)

Render consumer documentation site from DocJSON sources.

With no nav_path/output_dir, renders every configured render target ([[axiom_graph.site.targets]]) – or the subset named in targets – in its declared flavor (plain GFM or Sphinx/MyST). When no targets are configured an implicit guide (sphinx -> userdocs/guide) target is synthesised. Renders each doc to clean Markdown (no agent annotations, internal doc-id links stripped) with a provenance stamp.

nav_path/output_dir are single-target ad-hoc overrides that bypass the target list and render one nav-driven Sphinx subtree.

Parameters:

project_root str

Absolute path to the indexed project.

build bool

If True, also run sphinx-build after generating files (sphinx-format targets only).

nav_path str | None

Path to site-nav.yml ad-hoc override. Defaults to {project_root}/site-nav.yml.

output_dir str | None

Directory for the generated MyST pages ad-hoc override. Defaults to {project_root}/userdocs/guide.

targets list[str] | None

Optional list of target names to render; others are skipped.

Return type:

str