Skip to content

Commit

Permalink
Reformatted docs helper file
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWilhelm committed Jun 18, 2024
1 parent 30d9f4a commit 3df4643
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/scripts/gen_ref_nav.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,29 @@

nav = mkdocs_gen_files.Nav()

for path in sorted(Path("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(Path('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]
doc_path = doc_path.with_name("index.md")
full_doc_path = full_doc_path.with_name("index.md")
elif parts[-1] == "__main__":
doc_path = doc_path.with_name('index.md')
full_doc_path = full_doc_path.with_name('index.md')
elif parts[-1] == '__main__':
continue
elif parts[-1] == "_version":
elif parts[-1] == '_version':
continue

nav[parts] = doc_path.as_posix()

with mkdocs_gen_files.open(full_doc_path, "w") as fd:
ident = ".".join(parts)
fd.write(f"::: {ident}")
with mkdocs_gen_files.open(full_doc_path, 'w') as fd:
ident = '.'.join(parts)
fd.write(f'::: {ident}')

mkdocs_gen_files.set_edit_path(full_doc_path, path)

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

0 comments on commit 3df4643

Please sign in to comment.