Registry / web-framework / sphinx-inline-tabs

sphinx-inline-tabs

library2025.12.21.14pypypiunverified

Sphinx Inline Tabs is a Sphinx extension that allows you to add inline tabbed content to your documentation. This is useful for showing different command-line flags, code examples, or other content based on user preferences. The current version is `2025.12.21.14` and it follows a non-strict release cadence, often aligned with Sphinx releases or bug fixes.

web-framework

pip install sphinx-inline-tabs

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · SPHINX-INLINE-TABS

sphinx-inline-tabs

web-frameworkpythonv2025.12.21.14

Install

5.2s avg

Import

—

Disk

94MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2025.12.21.14 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.1MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 5.2s · import 0.000s · 93MB

94MB installed

● package 94MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

sphinx_inline_tabs

✓ extensions = ['sphinx_inline_tabs']

✗ from sphinx_inline_tabs import ...

This library is a Sphinx extension, not typically imported as a Python module in user code. It's enabled by adding its name to the `extensions` list in your Sphinx `conf.py` file.

To quickly use `sphinx-inline-tabs`, first create a basic Sphinx project (`sphinx-quickstart`). Then, add `sphinx_inline_tabs` to the `extensions` list in your `conf.py` file. Finally, define tabbed content using the `.. tabs::` directive and `.. group-tab::` (or `.. tab::`) sub-directives in your reStructuredText files, ensuring correct indentation. The provided code snippet shows the `conf.py` modification and an example RST structure.

# conf.py extensions = [ 'sphinx_inline_tabs', ] # index.rst (or any other .rst file where you want tabs) # .. tabs:: # # .. group-tab:: Python # # .. code-block:: python # # print("Hello from Python") # # .. group-tab:: Go # # .. code-block:: go # # package main # import "fmt" # func main() { # fmt.Println("Hello from Go") # }

Debug

Known issues

gotchaForgetting to add 'sphinx_inline_tabs' to the 'extensions' list in your Sphinx 'conf.py' file. This is the most common reason for the tabs not rendering or directives being unrecognized.

fix

Ensure `extensions = ['sphinx_inline_tabs']` (or append to existing list) is present in your `conf.py`.

affects: All versions

gotchaIncorrect reStructuredText (RST) indentation for `.. tabs::` and `.. group-tab::` directives. RST is whitespace-sensitive, and improper indentation will lead to rendering errors or unexpected output.

fix

Carefully follow the examples in the documentation regarding indentation. `.. group-tab::` must be indented relative to `.. tabs::`, and its content must be indented further.

affects: All versions

gotchaPotential visual inconsistencies with custom or older Sphinx themes. While `sphinx-inline-tabs` tries to be compatible, some themes might override default CSS/JS in a way that conflicts with the tab styling.

fix

If tabs look broken, try switching to a standard Sphinx theme (e.g., `furo`, `alabaster`). If the issue persists, inspect browser developer tools for CSS conflicts or open an issue on the library's GitHub page.

affects: All versions

Upgrade

Version history

2025.12.21.14latest on PyPI · released Dec 21, 2025

Audit

Dependencies

sphinxrequiredIt's a Sphinx extension and requires Sphinx to run.

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/pradyunsg/sphinx-inline-tabs ↗

packagehttps://pypi.org/project/sphinx-inline-tabs/ ↗

docshttps://sphinx-inline-tabs.readthedocs.io ↗