James VeitchandClaude Sonnet 4.6
526b00953d
- Roadmap: move logging-modernisation to Done; fix ADR links (root-relative paths corrected from ../../ADRs/ to project-management/ADRs/); add ADR-003 - epics/logging-modernisation.md: emptied after beacon epic finish archive - uv.lock: updated after `uv add --dev pyyaml` (needed by TestDockerCompose) - tests/test_packaging.py: ruff line-length formatting only - scripts/gen_ref_pages.py: trailing blank line (ruff) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RWysE6jYn4YjNorLBQ1cXb
39 lines
1.0 KiB
Python
39 lines
1.0 KiB
Python
"""Generate the code reference pages.
|
|
|
|
See: https://mkdocstrings.github.io/recipes/
|
|
"""
|
|
|
|
from pathlib import Path
|
|
|
|
import mkdocs_gen_files
|
|
|
|
nav = mkdocs_gen_files.Nav()
|
|
|
|
root = Path(__file__).parent.parent
|
|
src = root / "src"
|
|
|
|
for path in sorted(src.rglob("*.py")):
|
|
module_path = path.relative_to(src).with_suffix("")
|
|
doc_path = path.relative_to(src).with_suffix(".md")
|
|
full_doc_path = Path("reference", doc_path)
|
|
|
|
parts = tuple(module_path.parts)
|
|
|
|
if parts[-1] == "__init__":
|
|
parts = parts[:-1]
|
|
doc_path = doc_path.with_name("index.md")
|
|
full_doc_path = full_doc_path.with_name("index.md")
|
|
elif parts[-1] == "__main__":
|
|
continue
|
|
|
|
nav[parts] = doc_path.as_posix()
|
|
|
|
with mkdocs_gen_files.open(full_doc_path, "w") as fd:
|
|
ident = ".".join(parts)
|
|
fd.write(f"::: {ident}")
|
|
|
|
mkdocs_gen_files.set_edit_path(full_doc_path, path.relative_to(root))
|
|
|
|
with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
|
|
nav_file.writelines(nav.build_literate_nav())
|