Skip to content

Commit ea416bf

Browse files
committed
docs: Fix documentation
1 parent 1fb2cff commit ea416bf

3 files changed

Lines changed: 6 additions & 2 deletions

File tree

docs/gen_ref_nav.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77
nav = mkdocs_gen_files.Nav()
88

99
for path in sorted(Path("src").glob("**/*.py")):
10-
# if str(path) in exclude:
11-
# continue
1210
module_path = path.relative_to("src").with_suffix("")
1311
doc_path = path.relative_to("src").with_suffix(".md")
1412
full_doc_path = Path("reference", doc_path)

mkdocs.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,13 @@ plugins:
6666
- docs/gen_ref_nav.py
6767
- literate-nav:
6868
nav_file: SUMMARY.md
69+
- section-index
6970
- coverage
7071
- mkdocstrings:
72+
handlers:
73+
python:
74+
import:
75+
- https://mkdocstrings.github.io/objects.inv
7176
watch:
7277
- src/mkdocstrings
7378

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ docs = [
5555
"mkdocs-gen-files>=0.3",
5656
"mkdocs-literate-nav>=0.4",
5757
"mkdocs-material>=7.3",
58+
"mkdocs-section-index",
5859
"mkdocstrings>=0.16",
5960
"toml>=0.10",
6061
]

0 commit comments

Comments
 (0)