generate_reference_docs.py

# Copyright 2023 Unai Lería Fortea & Pablo Vizcaíno García

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Generate the code reference pages and navigation. Ty mkdocstrings"""

from pathlib import Path

import mkdocs_gen_files

nav = mkdocs_gen_files.Nav()

LICENSE = """<!-- Copyright 2023 PhasePortriat

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. -->
"""

# import shutil

# shutil.copy("README.md", "docs/index.md")
# shutil.copy("LICENSE", "docs/LICENSE.md")

for path in sorted(Path("phaseportrait").rglob("*.py")):
    module_path = path.with_suffix("")
    doc_path = path.with_suffix(".md")
    full_doc_path = Path("reference", doc_path)

    parts = tuple(module_path.parts)

    if parts[-1] == "__init__":
        continue
        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[("reference", *parts)] = full_doc_path.as_posix()

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

    mkdocs_gen_files.set_edit_path(full_doc_path, Path("../") / path)
    
    
for path in sorted(list(Path("examples").rglob("*.md"))):
    example_name = path.with_suffix("")
    doc_path = path.with_suffix(".md")
    full_doc_path = Path(doc_path)
    
    parts = tuple(example_name.parts)
    
    nav[("examples", *parts)] = full_doc_path.as_posix()

    with mkdocs_gen_files.open(full_doc_path, "w") as fd:
        ident = ".".join(parts)
        fd.write(''.join([line for line in open(path, 'r').readlines()]))

    mkdocs_gen_files.set_edit_path(full_doc_path, Path("../") / path)
    
with mkdocs_gen_files.open("SUMMARY.md", "w") as nav_file:
    nav_file.writelines(nav.build_literate_nav())