docs: generate hierarchical per-module API reference pages (#2103)
This commit is contained in:
parent
20dd94632e
commit
5388bea53a
1 changed files with 74 additions and 7 deletions
11
mkdocs.yml
11
mkdocs.yml
|
|
@ -25,7 +25,7 @@ nav:
|
|||
- Introduction: experimental/tasks.md
|
||||
- Server Implementation: experimental/tasks-server.md
|
||||
- Client Usage: experimental/tasks-client.md
|
||||
- API Reference: api.md
|
||||
- API Reference: api/
|
||||
|
||||
theme:
|
||||
name: "material"
|
||||
|
|
@ -115,10 +115,15 @@ plugins:
|
|||
- social:
|
||||
enabled: !ENV [ENABLE_SOCIAL_CARDS, false]
|
||||
- glightbox
|
||||
- gen-files:
|
||||
scripts:
|
||||
- docs/hooks/gen_ref_pages.py
|
||||
- literate-nav:
|
||||
nav_file: SUMMARY.md
|
||||
- mkdocstrings:
|
||||
handlers:
|
||||
python:
|
||||
paths: [src/mcp]
|
||||
paths: [src]
|
||||
options:
|
||||
relative_crossrefs: true
|
||||
members_order: source
|
||||
|
|
@ -126,8 +131,6 @@ plugins:
|
|||
show_signature_annotations: true
|
||||
signature_crossrefs: true
|
||||
group_by_category: false
|
||||
# 3 because docs are in pages with an H2 just above them
|
||||
heading_level: 3
|
||||
inventories:
|
||||
- url: https://docs.python.org/3/objects.inv
|
||||
- url: https://docs.pydantic.dev/latest/objects.inv
|
||||
|
|
|
|||
Loading…
Reference in a new issue