[](code_of_conduct.md) [](https://pypi.org/project/sphinx-mcp/#history) 
# sphinx-mcp
`sphinx-mcp` is a Sphinx extension for documenting MCP tools, prompts, resources and resource templates. The documentation of the extension including examples of MCP server documentation is available in the pre-compiled PDF: [sphinx-mcp.pdf](https://raw.githubusercontent.com/anirbanbasu/sphinx-mcp/master/sphinx-mcp.pdf).
# Limitations
- The limitations of the extension are documented in the aforementioned PDF.
- The project itself is in an early stage. It does not contain any testing yet.
# Contributing
Install [uv](https://docs.astral.sh/uv/getting-started/installation/). Install [`pre-commit`](https://pre-commit.com/) for Git by running `uv sync --all-groups`.
Then enable `pre-commit` by running the following in the directory where you clone this project.
```bash
pre-commit install
```
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Adhere to the [Code of Conduct](https://raw.githubusercontent.com/anirbanbasu/sphinx-mcp/master/CODE_OF_CONDUCT.md).
# License
[BSD 3-Clause](https://choosealicense.com/licenses/bsd-3-clause/).
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-mcp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "documentation, mcp, model-context-protocol, python3, sphinx, sphinx-doc, sphinx-documentation, sphinx-extension",
"author": null,
"author_email": "Anirban Basu <anirbanbasu@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/30/48/77e5a44ed254cdee6e36a78ad67112ab7b1395d9e8e53f8da8d6b80de1f2/sphinx_mcp-0.1.0a2.tar.gz",
"platform": null,
"description": "[](code_of_conduct.md) [](https://pypi.org/project/sphinx-mcp/#history) \n\n# sphinx-mcp\n\n`sphinx-mcp` is a Sphinx extension for documenting MCP tools, prompts, resources and resource templates. The documentation of the extension including examples of MCP server documentation is available in the pre-compiled PDF: [sphinx-mcp.pdf](https://raw.githubusercontent.com/anirbanbasu/sphinx-mcp/master/sphinx-mcp.pdf).\n\n# Limitations\n - The limitations of the extension are documented in the aforementioned PDF.\n - The project itself is in an early stage. It does not contain any testing yet.\n\n# Contributing\n\nInstall [uv](https://docs.astral.sh/uv/getting-started/installation/). Install [`pre-commit`](https://pre-commit.com/) for Git by running `uv sync --all-groups`.\n\nThen enable `pre-commit` by running the following in the directory where you clone this project.\n\n```bash\npre-commit install\n```\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nAdhere to the [Code of Conduct](https://raw.githubusercontent.com/anirbanbasu/sphinx-mcp/master/CODE_OF_CONDUCT.md).\n\n# License\n\n[BSD 3-Clause](https://choosealicense.com/licenses/bsd-3-clause/).\n",
"bugtrack_url": null,
"license": null,
"summary": "Sphinx extension for documenting MCP tools, prompts, resources and resource templates.",
"version": "0.1.0a2",
"project_urls": null,
"split_keywords": [
"documentation",
" mcp",
" model-context-protocol",
" python3",
" sphinx",
" sphinx-doc",
" sphinx-documentation",
" sphinx-extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9283df89ba89f0d457a726e37644ee1a9143fbcc3078d989aa3501134af4b6fd",
"md5": "b356419ff303dceb90ea68331044a6b9",
"sha256": "b95021f15cdf2c0a32ae3514360af7cc8e7d65c91f887fc234f57836dd6d18a5"
},
"downloads": -1,
"filename": "sphinx_mcp-0.1.0a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b356419ff303dceb90ea68331044a6b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 7321,
"upload_time": "2025-07-10T13:49:20",
"upload_time_iso_8601": "2025-07-10T13:49:20.852920Z",
"url": "https://files.pythonhosted.org/packages/92/83/df89ba89f0d457a726e37644ee1a9143fbcc3078d989aa3501134af4b6fd/sphinx_mcp-0.1.0a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "304877e5a44ed254cdee6e36a78ad67112ab7b1395d9e8e53f8da8d6b80de1f2",
"md5": "fb11304a42f55f9972d4019ed2951066",
"sha256": "05556291b6ff9e2ba932cd3471fd21bd7ac643ab7909924e86a5711b74b343a9"
},
"downloads": -1,
"filename": "sphinx_mcp-0.1.0a2.tar.gz",
"has_sig": false,
"md5_digest": "fb11304a42f55f9972d4019ed2951066",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 136644,
"upload_time": "2025-07-10T13:49:21",
"upload_time_iso_8601": "2025-07-10T13:49:21.877268Z",
"url": "https://files.pythonhosted.org/packages/30/48/77e5a44ed254cdee6e36a78ad67112ab7b1395d9e8e53f8da8d6b80de1f2/sphinx_mcp-0.1.0a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 13:49:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-mcp"
}
JSON