forked from openml/openml-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgen_ref_pages.py
More file actions
58 lines (41 loc) 路 1.83 KB
/
Copy pathgen_ref_pages.py
File metadata and controls
58 lines (41 loc) 路 1.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
"""Generate the code reference pages.
based on https://github.com/mkdocstrings/mkdocstrings/blob/33aa573efb17b13e7b9da77e29aeccb3fbddd8e8/docs/recipes.md
but modified for lack of "src/" file structure.
"""
from __future__ import annotations
from pathlib import Path
import mkdocs_gen_files
nav = mkdocs_gen_files.Nav()
root = Path(__file__).parent.parent
src = root / "openml"
for path in sorted(src.rglob("*.py")):
module_path = path.relative_to(root).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] = doc_path.as_posix()
with mkdocs_gen_files.open(full_doc_path, "w") as fd:
identifier = ".".join(parts)
print("::: " + identifier, 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())
nav = mkdocs_gen_files.Nav()
examples_dir = root / "examples"
examples_doc_dir = root / "docs" / "examples"
for path in sorted(examples_dir.rglob("*.py")):
if "_external_or_deprecated" in path.parts:
continue
dest_path = Path("examples") / path.relative_to(examples_dir)
with mkdocs_gen_files.open(dest_path, "w") as dest_file:
print(path.read_text(), file=dest_file)
new_relative_location = Path("../") / dest_path
nav[new_relative_location.parts[2:]] = new_relative_location.as_posix()
with mkdocs_gen_files.open("examples/SUMMARY.md", "w") as nav_file:
nav_file.writelines(nav.build_literate_nav())