sphinx-inline-tabs

What it is and what it does

sphinx-inline-tabs is a Sphinx extension that lets you embed tabbed content directly in your documentation markup. Once installed and added to your Sphinx conf.py extensions list, you can write inline tab blocks that render as interactive tab groups in the final HTML output. Tabs with matching labels automatically synchronize across the page—clicking one updates all others with the same label.

The extension is designed for minimal markup footprint and visual polish. All colors are configurable via CSS variables, making it easy to match your documentation theme. With active maintenance, MIT licensing, and a straightforward one-dependency install, it's a practical choice for documentation projects that need organized, space-efficient content presentation.

Use it for:

• Present code examples in multiple languages with synchronized tabs so readers see all variants at once.
• Document platform-specific instructions (Windows, macOS, Linux) in a single page with tab switching.
• Show different configuration options side-by-side without duplicating surrounding text.
• Organize API documentation by language or framework variant in a compact, navigable format.
• Create tabbed installation or setup guides that adapt to user choice.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Adds tabbed content blocks to Sphinx documentation with optional synchronization across pages.

Yes. Low install friction, active maintenance, MIT license, no known vulnerabilities, and a focused feature set make this a safe, practical addition to any Sphinx documentation project that would benefit from tabbed content organization.

Install

sphinx-inline-tabs on PyPI

pip install sphinx-inline-tabs

uv add sphinx-inline-tabs

poetry add sphinx-inline-tabs

Installing sphinx-inline-tabs

Before you install

Low friction install with a single runtime dependency on sphinx. Active maintenance with recent release and ongoing repository activity.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart

pip install sphinx-inline-tabs

Then add to conf.py:
extensions = [
    "sphinx_inline_tabs",
]

Requires Python >=3.8 and an existing Sphinx documentation project.

Verify before relying

• Whether JavaScript is truly optional for all use cases or only for the synchronization feature

Package facts

Evidence: sphinx_inline_tabs-2025.12.21.14-py3-none-any.whl

Tags

More Sphinx packages