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.6.0.tar.gz (23.9 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.6.0-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_filter_tabs-0.6.0.tar.gz
  • Upload date:
  • Size: 23.9 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.6.0.tar.gz
Algorithm Hash digest
SHA256 32aa4edfd9755f5da2245bc88b6bbcf720f29a36460f9b89303aeb507afe5a7c
MD5 ec87a111db1274f24aca6025cc0893f6
BLAKE2b-256 4eedd96ba6cc426118fa8bb4d52d16dd41e6a26ae1cdf027fde83f6af69f0732

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_filter_tabs-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7d1e7c63ef54fb425478aab7926a902bfe9f64858d60254e11a17c1ab06c3ed
MD5 995f17c9e42397d73bcef13d1803be98
BLAKE2b-256 a1131d0694cec0e5cd3b4d588e565a13b086486a6623dc3f66b2ac1586ca97f6

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