Skip to content

Commit

Permalink
add mkdocstrings attempt 7
Browse files Browse the repository at this point in the history
  • Loading branch information
rpetit3 committed Aug 8, 2024
1 parent 4bee97c commit 7dcc0a4
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/gen-ref-pages.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
"""Generate the code reference pages."""

from pathlib import Path

import mkdocs_gen_files

root = Path(__file__).parent.parent
src = root / "camlhmp"

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]
elif parts[-1] == "__main__":
continue

with mkdocs_gen_files.open(full_doc_path, "w") as fd:
identifier = ".".join(parts)
print("::: " + identifier, file=fd)

mkdocs_gen_files.set_edit_path(full_doc_path, path.relative_to(root))

0 comments on commit 7dcc0a4

Please sign in to comment.