mirror of
https://github.com/NVIDIA-NeMo/DataDesigner
synced 2026-05-24 09:48:29 +00:00
52 lines
1.6 KiB
Python
52 lines
1.6 KiB
Python
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
"""Generate the code reference pages and navigation."""
|
|
|
|
from pathlib import Path
|
|
|
|
import griffe
|
|
import mkdocs_gen_files
|
|
|
|
data = griffe.load("data_designer")
|
|
nav = mkdocs_gen_files.Nav()
|
|
|
|
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] == "__main__":
|
|
continue
|
|
|
|
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")
|
|
|
|
init_module = data[parts[1:]] if len(parts) > 1 else data
|
|
has_docstrings = init_module.has_docstring or any(
|
|
member.has_docstrings
|
|
for member in init_module.members.values()
|
|
if not (member.is_alias or member.is_module)
|
|
)
|
|
else:
|
|
has_docstrings = data[parts[1:]].has_docstrings
|
|
|
|
if not has_docstrings:
|
|
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}")
|
|
|
|
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())
|