Skip to content

Commit aff5b0e

Browse files
committed
Migrate to autodoc to mkdocs-api-autonav
1 parent d6e9c14 commit aff5b0e

File tree

4 files changed

+20
-69
lines changed

4 files changed

+20
-69
lines changed

docs/gen_ref_pages.py

Lines changed: 0 additions & 33 deletions
This file was deleted.

mkdocs.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ theme:
2424
- content.code.copy
2525
- content.tabs.link
2626
- content.tooltips
27+
- navigation.indexes
2728
- navigation.expand
2829
- navigation.footer
2930
- navigation.instant
@@ -65,12 +66,9 @@ plugins:
6566
show_if_no_docstring: true
6667
show_signature_annotations: true
6768
# Autodoc configuration.
68-
# https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
69-
- gen-files:
70-
scripts:
71-
- docs/gen_ref_pages.py
72-
- literate-nav:
73-
nav_file: SUMMARY.md
69+
# https://github.com/tlambert03/mkdocs-api-autonav#configuration
70+
- api-autonav:
71+
modules: ["src/fact"]
7472
# This plugin is used to validate URLs (including anchors).
7573
- htmlproofer:
7674
# This is not enabled by default because this requires network I/O, so it is inherently not
@@ -88,4 +86,3 @@ repo_url: https://github.com/johnthagen/python-blueprint
8886
edit_uri: edit/main/docs/user_guide/docs/
8987
nav:
9088
- index.md
91-
- Code Reference: reference/

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ docs = [
6060
# Python API documentation (not neccessary for applications).
6161
"mkdocstrings[python]",
6262
# Autodoc.
63-
"mkdocs-gen-files",
64-
"mkdocs-literate-nav",
63+
"mkdocs-api-autonav",
6564
]
6665
licenses = [
6766
"pip-licenses-cli",

uv.lock

Lines changed: 15 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)