Skip to content

Commit

Permalink
add mkdocstrings attempt 11
Browse files Browse the repository at this point in the history
  • Loading branch information
rpetit3 committed Aug 8, 2024
1 parent 08a3114 commit db0a63c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions .github/gen-ref-pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@
import mkdocs_gen_files

root = Path(__file__).parent.parent
src = root / "camlhmp"
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)
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__":
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)
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))
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ plugins:
default_handler: python
handlers:
python:
paths: [.]
paths: [camlhmp]
options:
show_source: true

Expand Down

0 comments on commit db0a63c

Please sign in to comment.