swagger-plugin-for-sphinx
Sphinx plugin which renders a OpenAPI specification with Swagger
Decision gist · record as of 2026-08-14
Yes. The plugin is actively maintained, has no known vulnerabilities, carries a permissive license, and installs with low friction. It directly solves the problem of embedding interactive API docs into Sphinx projects. Install it if you use Sphinx and need to include OpenAPI specifications in your documentation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low friction installation with a pure-Python wheel and five stable runtime dependencies.
- Active maintenance with a recent release (74 days ago) and ongoing repository activity.
License · maintenance · safety
Apache-2.0 (permissive) — Apache-2.0 permissive license allows commercial and private use with minimal restrictions; you must retain copyright and license notices.
last release 2026-06-01 (74 days) · last repo commit 2026-08-14 · 10 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 3,840,196 downloads/mo, #2,483 on PyPI
Alternatives
Verify before relying
pip install swagger-plugin-for-sphinx
# In conf.py:
extensions = ["swagger_plugin_for_sphinx"]
# In your .rst file:
.. swagger-plugin:: path/to/spec.yaml- Whether the plugin handles multiple OpenAPI versions or only specific versions
- Performance characteristics when embedding large or complex OpenAPI specifications
- Browser compatibility requirements for the generated Swagger UI pages
What it is and what it does
This is a Sphinx extension that brings OpenAPI specification rendering into your documentation build. It acts as a bridge between Sphinx's documentation generation and Swagger UI, letting you embed interactive API explorers directly into your HTML docs. The plugin uses a simple directive to include OpenAPI YAML or JSON files, automatically copying them into your build output and rendering them with Swagger UI's interactive interface.
The plugin depends on Sphinx, Jinja2, docutils, PyYAML, and typing_extensions to handle template rendering, specification parsing, and documentation generation. It supports multiple specifications per page with unique IDs, optional full-page rendering modes, and custom Swagger configuration options. You can point to CDN-hosted Swagger assets or mirror them locally into your documentation tree for offline or self-hosted deployments.
Use it for
- Embed live API documentation in Sphinx-generated project docs alongside narrative guides
- Render multiple OpenAPI specs on a single page with separate Swagger UI containers
- Self-host API documentation by mirroring Swagger UI assets into your build output
- Generate full-page Swagger UI views as part of your documentation site
- Pass custom Swagger configuration options to control UI behavior and appearance
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The plugin is actively maintained, has no known vulnerabilities, carries a permissive license, and installs with low friction. It directly solves the problem of embedding interactive API docs into Sphinx projects. Install it if you use Sphinx and need to include OpenAPI specifications in your documentation.
Install
swagger-plugin-for-sphinx on PyPI
Before you install
Low friction installation with a pure-Python wheel and five stable runtime dependencies. Active maintenance with a recent release (74 days ago) and ongoing repository activity.
License in practice
Apache-2.0 permissive license allows commercial and private use with minimal restrictions; you must retain copyright and license notices.
Quickstart
pip install swagger-plugin-for-sphinx
# In conf.py:
extensions = ["swagger_plugin_for_sphinx"]
# In your .rst file:
.. swagger-plugin:: path/to/spec.yamlVerify before relying
- Whether the plugin handles multiple OpenAPI versions or only specific versions
- Performance characteristics when embedding large or complex OpenAPI specifications
- Browser compatibility requirements for the generated Swagger UI pages
Package facts
| License | Apache-2.0 permissive |
| Python support | Supports the current Python release <4,>=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 5 packagessphinxjinja2docutilspyyamltyping_extensions |
| Maintenance | Actively maintained 74 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 3,840,196 / month, #2,483 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: PluginsFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Documentation :: SphinxTyping :: Typed |
Evidence: swagger_plugin_for_sphinx-7.2.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “swagger ui sphinx plugin”
- swagger-plugin-for-sphinxA Sphinx plugin that embeds interactive Swagger UI pages into…
- mkdocs-swagger-ui-tagA MkDocs plugin that embeds Swagger UI directly into documentation…
- sphinxcontrib-redocA Sphinx extension that embeds OpenAPI specifications rendered with…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also sphinxcontrib-openapi · mkdocs-swagger-ui-tag · mkdocs-render-swagger-plugin · swagger-ui-py · sphinxcontrib-redoc · flask-swagger-ui · sphinx-comments · django-rest-swagger · flask-openapi3-swagger · aiohttp-swagger