mirror of
https://github.com/open-jarvis/OpenJarvis.git
synced 2026-07-30 10:52:15 +00:00
Jon Saad-FalconandClaude Opus 4.6
0fb7bf8dd9
- Add gen-files and literate-nav mkdocs plugins - Create docs/gen_ref_pages.py (adapted from IPW) to auto-generate API reference pages - Replace 15 manual API nav entries with single auto-generated api-reference/ section - Add mkdocs-gen-files and mkdocs-literate-nav to docs extra dependencies Cross-pollinated from intelligence-per-watt docs patterns. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
32 lines
956 B
Python
32 lines
956 B
Python
"""Generate the code reference pages."""
|
|
from pathlib import Path
|
|
|
|
import mkdocs_gen_files
|
|
|
|
nav = mkdocs_gen_files.Nav()
|
|
src = Path("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("api-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].startswith("_"):
|
|
continue
|
|
|
|
nav[parts] = doc_path.as_posix()
|
|
|
|
with mkdocs_gen_files.open(full_doc_path, "w") as fd:
|
|
identifier = ".".join(parts)
|
|
fd.write(f"::: {identifier}")
|
|
|
|
mkdocs_gen_files.set_edit_path(full_doc_path, path)
|
|
|
|
with mkdocs_gen_files.open("api-reference/SUMMARY.md", "w") as nav_file:
|
|
nav_file.writelines(nav.build_literate_nav())
|