sphinx-tabs
Tabbed views for Sphinx
Decision gist · record as of 2026-08-14
Yes. This is a stable, actively maintained Sphinx extension with low install friction, no security issues, and a permissive license. If your documentation needs tabbed content—especially code examples in multiple languages or platform-specific instructions—it is a straightforward, well-supported choice.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx and Python 3.10 or later.
- Low friction install with a pure Python wheel.
- Actively maintained as of 2026-03-03 with recent commits and no known vulnerabilities.
License · maintenance · safety
MIT (permissive) — MIT license (permissive) means you can use, modify, and distribute this extension freely in both open-source and commercial projects with minimal restrictions.
last release 2026-03-03 (164 days) · last repo commit 2026-08-10 · 273 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 2,022,624 downloads/mo, #3,357 on PyPI
Alternatives
Verify before relying
pip install sphinx-tabs
Then in your Sphinx conf.py:
extensions = ['sphinx_tabs.tabs']
In your .rst file:
.. tabs::
.. tab:: Example
Content here- Whether the extension works with all Sphinx builders beyond HTML (the description mentions a configuration option for additional builders but does not specify which are supported by default).
- Performance characteristics when handling large numbers of tabs or deeply nested tab structures in a single documentation build.
What it is and what it does
sphinx-tabs is a Sphinx extension that renders tabbed interfaces in HTML documentation. It lets you organize content into clickable tabs that users can switch between, with support for basic tabs, grouped tabs that stay synchronized across the page, and code tabs with syntax highlighting. The extension is configured by adding a single line to your Sphinx conf.py and then using reStructuredText directives in your documentation source.
The package depends on sphinx, pygments, and docutils—all core Sphinx components—so it integrates seamlessly into existing documentation workflows. It has been actively maintained since 2017, supports Python 3.10 through 3.14, and carries no known security vulnerabilities. The MIT license permits use in any project.
Use it for
- Display code examples in multiple programming languages with tabs for each language, letting readers switch between implementations.
- Create platform-specific instructions (Linux, macOS, Windows) where selecting one tab automatically selects the same platform in other sections.
- Organize API documentation by endpoint type or category, reducing page length and improving readability.
- Build multi-version or multi-variant documentation where users need to see content for their specific use case.
- Present before-and-after or comparison content side-by-side in a compact, user-controlled format.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
This is a stable, actively maintained Sphinx extension with low install friction, no security issues, and a permissive license. If your documentation needs tabbed content—especially code examples in multiple languages or platform-specific instructions—it is a straightforward, well-supported choice.
Install
sphinx-tabs on PyPI
Before you install
Low friction install with a pure Python wheel. Actively maintained as of 2026-03-03 with recent commits and no known vulnerabilities. Depends only on sphinx, pygments, and docutils—all standard documentation tooling.
Requires Sphinx and Python 3.10 or later.
License in practice
MIT license (permissive) means you can use, modify, and distribute this extension freely in both open-source and commercial projects with minimal restrictions.
Quickstart
pip install sphinx-tabs
Then in your Sphinx conf.py:
extensions = ['sphinx_tabs.tabs']
In your .rst file:
.. tabs::
.. tab:: Example
Content hereVerify before relying
- Whether the extension works with all Sphinx builders beyond HTML (the description mentions a configuration option for additional builders but does not specify which are supported by default).
- Performance characteristics when handling large numbers of tabs or deeply nested tab structures in a single documentation build.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagessphinxpygmentsdocutils |
| Maintenance | Actively maintained 164 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 2,022,624 / month, #3,357 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 :: PluginsEnvironment :: Web EnvironmentFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software Development :: DocumentationTopic :: Text ProcessingTopic :: Utilities |
Evidence: sphinx_tabs-3.5.0-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 › “documentation tabs extension”
- sphinx-tabsA Sphinx extension that adds tabbed content blocks to HTML…
- sphinx-inline-tabsAdds tabbed content blocks to Sphinx documentation with optional…
- sphinx_designA Sphinx extension that adds responsive web component directives for…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also sphinx-inline-tabs · sphinx-panels · sphinx-multitoc-numbering · sphinx_design · sphinx-issues · sphinx-substitution-extensions · readthedocs-sphinx-search · sphinx-gallery · sphinx-jinja · sphinx-togglebutton