Skip to main content

A Sphinx extension for accessible, JS-free filterable content tabs.

Project description

Sphinx Filter Tabs Extension

A robust Sphinx extension for creating accessible, JavaScript-free, filterable content tabs.

📖 View extension and documentation at: https://aputtu.github.io/sphinx-filter-tabs/

This extension provides filter-tabs and tab directives to create user-friendly, switchable content blocks, ideal for showing code examples in multiple languages or instructions for different platforms.

Features

  • No JavaScript: Pure CSS implementation ensures maximum compatibility, speed, and accessibility.
  • WAI-ARIA Compliant: The generated HTML follows accessibility best practices for keyboard navigation and screen readers.
  • Highly Customizable: Easily theme colors, fonts, and sizes directly from your conf.py using CSS Custom Properties.
  • Graceful Fallback: Renders content as simple admonitions in non-HTML outputs like PDF/LaTeX.
  • Automated Testing: CI/CD pipeline tests against multiple Sphinx versions to ensure compatibility.

Installation

You can install this extension using pip:

pip install sphinx-filter-tabs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_filter_tabs-0.7.0.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_filter_tabs-0.7.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_filter_tabs-0.7.0.tar.gz.

File metadata

  • Download URL: sphinx_filter_tabs-0.7.0.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for sphinx_filter_tabs-0.7.0.tar.gz
Algorithm Hash digest
SHA256 083bfba615376b7be47b675d0861dc93055c5f8bf164f5a6e50f82061d1ce334
MD5 3bacb5542a1eb98c204a8d49eb7b1601
BLAKE2b-256 682e5c0dbf03b39154d626aa590ed29f8dea3528fbd1b4f88a318bb2e97ec6c4

See more details on using hashes here.

File details

Details for the file sphinx_filter_tabs-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_filter_tabs-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b3731c8bce4dcf0bee3a0c932cfce6b4c893a20da3d4ac7e8f26eda18a1083b4
MD5 a9794501644577927b2df526ddc9de92
BLAKE2b-256 0f122f097a8e3215e6009e9f2d40eebb86667617214ccc2b11ddeb0f544fb3ab

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page