sphinx-tabs

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

A Sphinx extension that adds tabbed content blocks to HTML documentation, supporting basic tabs, grouped tabs with synchronized selection, and syntax-highlighted code tabs.

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

pip install sphinx-tabs

uv add sphinx-tabs

poetry add sphinx-tabs

Installing sphinx-tabs

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.

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 here

Requires Sphinx and Python 3.10 or later.

Verify 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

Evidence: sphinx_tabs-3.5.0-py3-none-any.whl

Tags

More Utilities packages