Skip to content

Commit 36ebfb2

Browse files
committed
docs(packages): Add sphinx-autodoc-fastmcp package page and redirects
why: Publish package reference in docs; legacy extensions/* redirects; CHANGES entry; doctest expectations for workspace discovery. what: - docs/packages/sphinx-autodoc-fastmcp.md and redirects.txt line - package_reference doctest set; test_package_reference expected names - CHANGES bullet for the new extension
1 parent c064822 commit 36ebfb2

File tree

5 files changed

+30
-0
lines changed

5 files changed

+30
-0
lines changed

CHANGES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ $ uv add gp-sphinx --prerelease allow
2020

2121
### Features
2222

23+
- `sphinx-autodoc-fastmcp`: new Sphinx extension for FastMCP tool docs (card-style
24+
`desc` layouts, safety badges, MyST directives, cross-reference roles)
2325
- Initial release of `gp_sphinx` shared documentation platform
2426
- `merge_sphinx_config()` API for building complete Sphinx config from shared defaults
2527
- Shared extension list, theme options, MyST config, font config

docs/_ext/package_reference.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
... "sphinx-gptheme",
4242
... "sphinx-argparse-neo",
4343
... "sphinx-autodoc-docutils",
44+
... "sphinx-autodoc-fastmcp",
4445
... "sphinx-autodoc-pytest-fixtures",
4546
... "sphinx-autodoc-sphinx",
4647
... }
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
(sphinx-autodoc-fastmcp)=
2+
3+
# sphinx-autodoc-fastmcp
4+
5+
{bdg-warning-line}`Alpha` {bdg-link-secondary-line}`GitHub <https://github.com/git-pull/gp-sphinx/tree/main/packages/sphinx-autodoc-fastmcp>` {bdg-link-secondary-line}`PyPI <https://pypi.org/project/sphinx-autodoc-fastmcp/>`
6+
7+
Sphinx extension for documenting **FastMCP** tools: card-style `desc` layouts
8+
(aligned with {doc}`sphinx-autodoc-api-style`), safety badges, parameter tables,
9+
and cross-reference roles (`:tool:`, `:toolref:`, `:badge:`, etc.).
10+
11+
```console
12+
$ pip install sphinx-autodoc-fastmcp
13+
```
14+
15+
## Features
16+
17+
- **Tool cards**: `mcp` / `tool` domain `desc` nodes with toolbar badges
18+
- **Collectors**: `register(mcp)`-style modules or `introspect` mode for `@mcp.tool`
19+
- **Configuration**: module list, area map, model classes for type cross-refs
20+
- **MyST directives**: `fastmcp-tool`, `fastmcp-tool-input`, `fastmcp-toolsummary`
21+
22+
## Package reference
23+
24+
```{package-reference} sphinx-autodoc-fastmcp
25+
```

docs/redirects.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ extensions/sphinx-autodoc-pytest-fixtures packages/sphinx-autodoc-pytest-fixture
55
extensions/sphinx-autodoc-docutils packages/sphinx-autodoc-docutils
66
extensions/sphinx-autodoc-sphinx packages/sphinx-autodoc-sphinx
77
extensions/sphinx-autodoc-api-style packages/sphinx-autodoc-api-style
8+
extensions/sphinx-autodoc-fastmcp packages/sphinx-autodoc-fastmcp
89
extensions/sphinx-fonts packages/sphinx-fonts
910
extensions/sphinx-gptheme packages/sphinx-gptheme

tests/test_package_reference.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ def test_workspace_packages_lists_publishable_packages() -> None:
2323
"sphinx-argparse-neo",
2424
"sphinx-autodoc-api-style",
2525
"sphinx-autodoc-docutils",
26+
"sphinx-autodoc-fastmcp",
2627
"sphinx-autodoc-pytest-fixtures",
2728
"sphinx-autodoc-sphinx",
2829
"sphinx-fonts",

0 commit comments

Comments
 (0)