sphinx-filter-tabs: Accessible Filters

Introduction

sphinx-filter-tabs adds accessible, filterable content groups to Sphinx documentation.

Use it when one topic needs short alternatives for different contexts, such as programming languages, operating systems, deployment environments, or installation methods.

Key features:

  • CSS-first design: Uses semantic HTML and CSS; no JavaScript is required for the core tab behavior.

  • Accessible structure: Uses native form controls, legends, labels, and ARIA relationships.

  • Keyboard navigation: Uses browser-native radio button behavior.

  • Theme integration: Follows the active Sphinx theme by default, with optional color and layout settings in conf.py.

  • Opt-in collapsible admonitions: Can render admonitions marked with sft-collapsible as details/summary when filter_tabs_enable_collapsible_admonitions is enabled.

  • Fallback output: Renders readable sequential content in non-HTML outputs such as PDF and LaTeX.

  • Default tab selection: Use (default) in a tab title to choose the initially selected tab.

You can find the project’s source code on the GitHub repository.

You can also download this documentation as a PDF file.