Skip to content

Commit

Permalink
Add script to generate references for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nikochiko committed Sep 16, 2024
1 parent bc5ac19 commit 9ba8557
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
1 change: 1 addition & 0 deletions .fernignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ src/gooey/core/http_client.py
src/gooey/core/pydantic_utilities.py
docs/
mkdocs.yml
scripts/
46 changes: 46 additions & 0 deletions scripts/gen_ref_pages.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
"""Generate the code reference pages."""

import importlib
from pathlib import Path

import mkdocs_gen_files


nav = mkdocs_gen_files.Nav()
mod_symbol = '<code class="doc-symbol doc-symbol-nav doc-symbol-module"></code>'

root = Path(__file__).parent.parent
src = root / "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("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] == "__main__":
continue

nav_parts = [f"{mod_symbol} {part}" for part in parts]
nav[tuple(nav_parts)] = doc_path.as_posix()

with mkdocs_gen_files.open(full_doc_path, "w") as fd:
identifier = ".".join(parts)
print(f"---\ntitle: {identifier}\n---\n\n::: {identifier}", file=fd)

if identifier.endswith("gooey"):
print(" handler: python", file=fd)
print(" options:", file=fd)
print(" members:", file=fd)
print(" - Gooey", file=fd)
print(" - AsyncGooey", file=fd)

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

with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
nav_file.writelines(nav.build_literate_nav())

0 comments on commit 9ba8557

Please sign in to comment.