Commit fc69603
committed
docs: generate hierarchical per-module API reference pages
The API docs previously consisted of a single page (`docs/api.md`)
containing only `::: mcp`, which rendered just the top-level
`mcp/__init__.py` exports. Most of the public API surface (`MCPServer`,
`Context`, `Settings`, `Tool`, `Resource`, `Prompt`, etc.) was missing
because those classes live in subpackages not re-exported at the top
level.
This replaces the single-page approach with auto-generated per-module
pages using the standard mkdocstrings recipe:
- `mkdocs-gen-files` runs `docs/hooks/gen_ref_pages.py` at build time to
create a virtual `.md` stub for every module under `src/mcp/`
- `mkdocs-literate-nav` reads the generated `api/SUMMARY.md` to build a
hierarchical sidebar navigation tree
- Material theme's `navigation.indexes` handles section index pages (the
`mkdocs-section-index` plugin is not needed and conflicts with it)
Also updates `mkdocstrings` `paths` from `[src/mcp]` to `[src]` so that
fully-qualified module identifiers like `mcp.server.mcpserver.server`
resolve correctly.1 parent 0fe16dd commit fc69603
File tree
7 files changed
+74
-7
lines changed- docs
- hooks
7 files changed
+74
-7
lines changedThis file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
| 67 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
828 | 828 | | |
829 | 829 | | |
830 | 830 | | |
831 | | - | |
| 831 | + | |
832 | 832 | | |
833 | 833 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
118 | 123 | | |
119 | 124 | | |
120 | 125 | | |
121 | | - | |
| 126 | + | |
122 | 127 | | |
123 | 128 | | |
124 | 129 | | |
125 | 130 | | |
126 | 131 | | |
127 | 132 | | |
128 | 133 | | |
129 | | - | |
130 | | - | |
131 | 134 | | |
132 | 135 | | |
133 | 136 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
74 | 74 | | |
75 | 75 | | |
76 | 76 | | |
| 77 | + | |
77 | 78 | | |
| 79 | + | |
78 | 80 | | |
79 | 81 | | |
80 | 82 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments