Skip to content

Commit 6d1aec8

Browse files
committed
refactor: Simplify API docs (stop using gen-files and literate-nav)
1 parent 5b139cc commit 6d1aec8

File tree

4 files changed

+8
-47
lines changed

4 files changed

+8
-47
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: API reference
3+
hide:
4+
- navigation
5+
---
6+
7+
# ::: {{ python_package_import_name }}

project/mkdocs.yml.jinja

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ nav:
1919
- Changelog: changelog.md
2020
- Credits: credits.md
2121
- License: license.md
22-
# defer to gen-files + literate-nav
23-
- API reference: reference/
22+
- API reference: reference/api.md
2423
- Development:
2524
- Contributing: contributing.md
2625
- Code of Conduct: code_of_conduct.md
@@ -117,11 +116,6 @@ plugins:
117116
- search
118117
- markdown-exec
119118
- section-index
120-
- gen-files:
121-
scripts:
122-
- scripts/gen_api_ref.py
123-
- literate-nav:
124-
nav_file: SUMMARY.txt
125119
- coverage
126120
- mkdocstrings:
127121
handlers:

project/pyproject.toml.jinja

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,7 @@ ci = [
9999
"markdown-exec>=1.8",
100100
"mkdocs>=1.6",
101101
"mkdocs-coverage>=1.0",
102-
"mkdocs-gen-files>=0.5",
103102
"mkdocs-git-revision-date-localized-plugin>=1.2",
104-
"mkdocs-literate-nav>=0.6",
105103
"mkdocs-llmstxt>=0.1",
106104
"mkdocs-material>=9.5",
107105
"mkdocs-minify-plugin>=0.8",

project/scripts/gen_api_ref.py.jinja

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

0 commit comments

Comments
 (0)