From cd548e9c716072013feb95d695bb66a66d7ed216 Mon Sep 17 00:00:00 2001 From: patnr Date: Fri, 1 Nov 2024 17:58:36 +0100 Subject: [PATCH] Slightly simplify script --- docs/gen_ref_pages.py | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py index b861d7ac..74c56e8d 100644 --- a/docs/gen_ref_pages.py +++ b/docs/gen_ref_pages.py @@ -16,25 +16,21 @@ 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) @@ -42,7 +38,7 @@ 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".