Skip to content

Commit

Permalink
Slightly simplify script
Browse files Browse the repository at this point in the history
  • Loading branch information
patnr committed Nov 1, 2024
1 parent e970ca5 commit cd548e9
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions docs/gen_ref_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,29 @@
src = root / "dapper"

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)
parts = tuple(path.relative_to(src).with_suffix("").parts)
path_md = Path("reference", path.relative_to(src).with_suffix(".md"))

if parts[-1] == "__init__":
parts = parts[:-1] or src.parts[-1:]
if not parts:
# we're in root pkg
parts = src.parts[-1:]
doc_path = doc_path.with_name("index.md")
full_doc_path = full_doc_path.with_name("index.md")
path_md = path_md.with_name("index.md")
elif parts[-1] == "__main__":
continue

# PS: rm `mkdocs_gen_files` to get to inspect actual .md files
# NB: will (over)write in docs/ folder.
with mkdocs_gen_files.open(full_doc_path, "w") as fd:
with mkdocs_gen_files.open(path_md, "w") as fd:
# Explicitly set the title to avoid mkdocs capitalizing
# names and removing underscores (only applies to files)
print(f"# {parts[-1]}", file=fd)

identifier = ".".join(parts)
print("::: " + identifier, file=fd)

mkdocs_gen_files.set_edit_path(full_doc_path, ".." / path.relative_to(root))
mkdocs_gen_files.set_edit_path(path_md, ".." / path.relative_to(root))

# > So basically, you can use the literate-nav plugin just for its ability to
# > infer only sub-directories, without ever writing any actual "literate navs".
Expand Down

0 comments on commit cd548e9

Please sign in to comment.