-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
- Loading branch information
There are no files selected for viewing
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
"""Generate the api pages and navigation. | ||
""" | ||
|
||
from pathlib import Path | ||
|
||
import mkdocs_gen_files | ||
from mkdocs.utils import log | ||
|
||
ignored_stems = ["__init__", "_version"] | ||
|
||
added = 0 | ||
add_limit = None | ||
|
||
nav = mkdocs_gen_files.Nav() | ||
for path in sorted(Path("src/spyglass/").glob("**/*.py")): | ||
if path.stem in ignored_stems or "cython" in path.stem: | ||
continue | ||
rel_path = path.relative_to("src/spyglass") | ||
with mkdocs_gen_files.open(f"api/{rel_path.with_suffix('')}.md", "w") as f: | ||
module_path = ".".join([p for p in path.with_suffix("").parts]) | ||
print(f"::: {module_path}", file=f) | ||
nav[rel_path.parts] = f"{rel_path.with_suffix('')}.md" | ||
|
||
if add_limit is not None: | ||
if added < add_limit: | ||
log.warning(f"Generated {rel_path.with_suffix('')}.md") | ||
added += 1 | ||
else: | ||
break | ||
|
||
|
||
with mkdocs_gen_files.open("api/navigation.md", "w") as nav_file: | ||
nav_file.write("* [Overview](../api/index.md)\n") | ||
nav_file.writelines(nav.build_literate_nav()) |