Skip to content

Commit 3b769b7

Browse files
committed
docs: Simplify API docs
1 parent b04c64d commit 3b769b7

File tree

4 files changed

+13
-49
lines changed

4 files changed

+13
-49
lines changed

docs/reference/mkdocs_autorefs.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: mkdocs-autorefs API reference
3+
hide:
4+
- navigation
5+
---
6+
7+
# ::: mkdocs_autorefs
8+
options:
9+
summary:
10+
classes: true
11+
functions: true
12+
attributes: true

mkdocs.yml

Lines changed: 1 addition & 8 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/mkdocs_autorefs.md
2423
- Development:
2524
- Contributing: contributing.md
2625
- Code of Conduct: code_of_conduct.md
@@ -101,12 +100,6 @@ plugins:
101100
- autorefs
102101
- search
103102
- markdown-exec
104-
- section-index
105-
- gen-files:
106-
scripts:
107-
- scripts/gen_api_ref.py
108-
- literate-nav:
109-
nav_file: SUMMARY.txt
110103
- coverage
111104
- mkdocstrings:
112105
handlers:

pyproject.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,10 @@ dev = [
103103
"markdown-exec>=1.8",
104104
"mkdocs>=1.6",
105105
"mkdocs-coverage>=1.0",
106-
"mkdocs-gen-files>=0.5",
107106
"mkdocs-git-revision-date-localized-plugin>=1.2",
108-
"mkdocs-literate-nav>=0.6",
109107
"mkdocs-llmstxt>=0.1",
110108
"mkdocs-material>=9.5",
111109
"mkdocs-minify-plugin>=0.8",
112-
"mkdocs-section-index>=0.3",
113110
"mkdocstrings[python]>=0.25",
114111
# YORE: EOL 3.10: Remove line.
115112
"tomli>=2.0; python_version < '3.11'",

scripts/gen_api_ref.py

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

0 commit comments

Comments
 (0)