sphinx-filter-tabs 1.2.2__py3-none-any.whl → 1.2.6__py3-none-any.whl

filter_tabs/extension.py

@@ -419,12 +419,31 @@ def depart_summary_node(self: HTML5Translator, node: SummaryNode) -> None:
     self.body.append('</summary>')
 
 
+# =============================================================================
+# Use ARIA to Improve Strong Element Behavior
+# =============================================================================
+
+def improve_inline_formatting(app: Sphinx, doctree: nodes.document, docname: str):
+    """Improve screen reader handling of inline formatting."""
+    if app.builder.name != 'html':
+        return
+        
+    # Find all strong/emphasis nodes and add ARIA attributes
+    for node in doctree.findall(nodes.strong):
+        # Add aria-label to make the content read as one unit
+        text_content = node.astext()
+        node['aria-label'] = text_content
+        
+    for node in doctree.findall(nodes.emphasis):
+        text_content = node.astext()
+        node['aria-label'] = text_content
+
 # =============================================================================
 # Static File Handling
 # =============================================================================
 
 def copy_static_files(app: Sphinx):
-    """Copy CSS and JS files to the build directory."""
+    """Copy CSS file to the build directory."""
     if app.builder.name != 'html':
         return
         
@@ -436,11 +455,7 @@ def copy_static_files(app: Sphinx):
     css_file = static_source_dir / "filter_tabs.css"
     if css_file.exists():
         shutil.copy(css_file, dest_dir)
-    
-    # Copy JS file if it exists
-    js_file = static_source_dir / "filter_tabs.js"
-    if js_file.exists():
-        shutil.copy(js_file, dest_dir)
+
 
 
 # =============================================================================
@@ -456,7 +471,6 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     
     # Add static files
     app.add_css_file('filter_tabs.css')
-    app.add_js_file('filter_tabs.js')
     
     # Register custom nodes (keep existing node registration code)
     app.add_node(ContainerNode, html=(visit_container_node, depart_container_node))
@@ -475,6 +489,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     # Connect event handlers
     app.connect('builder-inited', copy_static_files)
     app.connect('doctree-resolved', setup_collapsible_admonitions)
+    app.connect('doctree-resolved', improve_inline_formatting)
     
     return {
         'version': __version__,

filter_tabs/renderer.py

@@ -46,31 +46,31 @@ class ContentTypeInferrer:
         (['development', 'staging', 'production', 'test', 'local'], 'environment'),
         (['source', 'binary', 'docker', 'manual', 'automatic'], 'installation method'),
     ]
-    
+
     @classmethod
     def infer_type(cls, tab_names: List[str]) -> str:
         """
         Infer content type from a list of tab names.
-        
+
         Args:
             tab_names: List of tab names to analyze
-            
+
         Returns:
             Inferred content type string (e.g., 'programming language', 'operating system')
         """
         lower_names = [name.lower() for name in tab_names]
-        
+
         # First pass: exact matches
         for keywords, content_type in cls.PATTERNS:
             if any(name in keywords for name in lower_names):
                 return content_type
-        
+
         # Second pass: substring matches
         for keywords, content_type in cls.PATTERNS:
             for name in lower_names:
                 if any(keyword in name for keyword in keywords):
                     return content_type
-        
+
         # Default fallback
         return 'option'
 
@@ -92,53 +92,52 @@ class FilterTabsRenderer:
         self.tab_data = tab_data
         self.general_content = general_content
         self.custom_legend = custom_legend
-        
+
         # 1. Load configuration first
         self.config = FilterTabsConfig.from_sphinx_config(self.app.config)
-        
+
         # 2. Safely initialize the counter on the environment if it doesn't exist
         if not hasattr(self.env, 'filter_tabs_counter'):
             self.env.filter_tabs_counter = 0
-            
+
         # 3. Increment the counter for this new tab group
         self.env.filter_tabs_counter += 1
-        
+
         # 4. Generate the unique group ID and the ID generator instance
         self.group_id = f"filter-group-{self.env.filter_tabs_counter}"
         self.id_gen = IDGenerator(self.group_id)
-        
+
         # 5. Perform debug logging now that config and group_id are set
         if self.config.debug_mode:
             logger.info(f"Initialized new tab group with id: '{self.group_id}'")
 
     def render_html(self) -> List[nodes.Node]:
-        """Render HTML with a browser-compatible CSS approach."""
+        """Render HTML with CSS-only approach (no inline styles)."""
         if self.config.debug_mode:
             logger.info(f"Rendering filter-tabs group {self.group_id}")
 
-        css_node = self._generate_compatible_css()
-
         container_attrs = self._get_container_attributes()
         container = ContainerNode(**container_attrs)
 
         fieldset = self._create_fieldset()
         container.children = [fieldset]
-        
-        return [css_node, container]
+
+        # FIXED: No more inline CSS generation
+        return [container]
 
     def render_fallback(self) -> List[nodes.Node]:
         """Render for non-HTML builders (e.g., LaTeX)."""
         output_nodes: List[nodes.Node] = []
-        
+
         if self.general_content:
             output_nodes.extend(copy.deepcopy(self.general_content))
-        
+
         for tab in self.tab_data:
             admonition = nodes.admonition()
             admonition += nodes.title(text=tab.name)
             admonition.extend(copy.deepcopy(tab.content))
             output_nodes.append(admonition)
-        
+
         return output_nodes
 
     def _get_container_attributes(self) -> Dict[str, Any]:
@@ -150,42 +149,29 @@ class FilterTabsRenderer:
             'style': self.config.to_css_properties()
         }
 
-    def _generate_compatible_css(self) -> nodes.raw:
-        """Generate CSS using sibling selectors to show/hide panels."""
-        css_rules = []
-        for i, tab in enumerate(self.tab_data):
-            radio_id = self.id_gen.radio_id(i)
-            panel_id = self.id_gen.panel_id(i)
-            css_rules.append(
-                f"#{radio_id}:checked ~ .{SFT_CONTENT} #{panel_id} {{ display: block; }}"
-            )
-        
-        css_content = "\n".join(css_rules)
-        return nodes.raw(text=f"<style>\n{css_content}\n</style>", format='html')
-
     def _create_fieldset(self) -> FieldsetNode:
         """Create the main fieldset containing the legend, radio buttons, and panels."""
         fieldset = FieldsetNode(role="radiogroup")
-        
+
         fieldset += self._create_legend()
-        
+
         radio_group = ContainerNode(classes=[SFT_RADIO_GROUP])
         self._populate_radio_group(radio_group)
-        
+
         content_area = ContainerNode(classes=[SFT_CONTENT])
         self._populate_content_area(content_area)
-        
+
         # This is the fix: place the content_area inside the radio_group.
         radio_group += content_area
-        
+
         fieldset += radio_group
-        
+
         return fieldset
 
     def _create_legend(self) -> LegendNode:
         """Create a meaningful, visible legend for the tab group."""
         legend = LegendNode(classes=[SFT_LEGEND], ids=[self.id_gen.legend_id()])
-        
+
         # Use the custom legend if it exists
         if self.custom_legend:
             legend_text = self.custom_legend
@@ -194,27 +180,30 @@ class FilterTabsRenderer:
             tab_names = [tab.name for tab in self.tab_data]
             content_type = ContentTypeInferrer.infer_type(tab_names)
             legend_text = f"Choose {content_type}: {', '.join(tab_names)}"
-        
+
         legend += nodes.Text(legend_text)
         return legend
 
     def _populate_radio_group(self, radio_group: ContainerNode) -> None:
         """Create and add all radio buttons and labels to the radio group container."""
         default_index = next((i for i, tab in enumerate(self.tab_data) if tab.is_default), 0)
-     
+
         for i, tab in enumerate(self.tab_data):
             radio_group += self._create_radio_button(i, tab, is_checked=(i == default_index))
             radio_group += self._create_label(i, tab)
             radio_group += self._create_screen_reader_description(i, tab)
 
     def _create_radio_button(self, index: int, tab: TabData, is_checked: bool) -> RadioInputNode:
-        """Create a single radio button input."""
+        """Create a single radio button input with data attribute."""
         radio = RadioInputNode(
             classes=['sr-only'],
             type='radio',
             name=self.group_id,
             ids=[self.id_gen.radio_id(index)],
-            **{'aria-describedby': self.id_gen.desc_id(index)}
+            **{
+                'aria-describedby': self.id_gen.desc_id(index),
+                'data-tab-index': str(index)  # FIXED: Add data attribute
+            }
         )
         if tab.aria_label:
             radio['aria-label'] = tab.aria_label
@@ -236,26 +225,34 @@ class FilterTabsRenderer:
         return description_node
 
     def _populate_content_area(self, content_area: ContainerNode) -> None:
-        """Create and add all general and tab-specific content panels."""
+        """Create and add all general and tab-specific content panels with accessibility enhancements."""
         if self.general_content:
-            general_panel = PanelNode(classes=[SFT_PANEL], **{'data-filter': 'General'})
+            general_panel = PanelNode(
+                classes=[SFT_PANEL], 
+                **{
+                    'data-filter': 'General',
+                    'aria-label': 'General information',
+                    'role': 'region'
+                }
+            )
             general_panel.extend(copy.deepcopy(self.general_content))
             content_area += general_panel
-        
+
         for i, tab in enumerate(self.tab_data):
             content_area += self._create_tab_panel(i, tab)
 
     def _create_tab_panel(self, index: int, tab: TabData) -> PanelNode:
-        """Create a single content panel for a tab."""
+        """Create a single content panel for a tab - CSS only version."""
         panel_attrs = {
             'classes': [SFT_PANEL],
             'ids': [self.id_gen.panel_id(index)],
-            'role': 'region',
+            'role': 'tabpanel',
             'aria-labelledby': self.id_gen.radio_id(index),
-            'tabindex': '0',
-            'data-tab': tab.name.lower().replace(' ', '-')
+            'tabindex': '0',  # Keep for keyboard accessibility
+            'data-tab': tab.name.lower().replace(' ', '-'),
+            'data-tab-index': str(index)
         }
         panel = PanelNode(**panel_attrs)
         panel.extend(copy.deepcopy(tab.content))
         return panel
-    
+    

filter_tabs/static/filter_tabs.css

@@ -1,4 +1,4 @@
-/* Sphinx Filter Tabs - Simplified Accessibility-First Stylesheet */
+/* Sphinx Filter Tabs - Enhanced CSS with improved accessibility */
 
 /* Main container */
 .sft-container {
@@ -86,7 +86,7 @@
 /* Content area */
 .sft-content {
     padding: 20px;
-    flex-basis: 100%; /* Add this line */
+    flex-basis: 100%;
 }
 
 /* Panels - hidden by default */
@@ -95,11 +95,39 @@
     outline: none;
 }
 
-/* Focus styling for panels */
+/* Enhanced focus styling for CSS-only version */
 .sft-panel:focus {
-    outline: 2px solid var(--sft-highlight-color, #007bff);
-    outline-offset: -2px;
+    outline: 3px solid var(--sft-highlight-color, #007bff);
+    outline-offset: 2px;
     border-radius: 4px;
+    background: rgba(0, 123, 255, 0.05);
+    /* Ensure smooth transition */
+    transition: background-color 0.2s ease;
+}
+
+/* Visual focus indicator for better UX */
+.sft-panel:focus::before {
+    content: "→ ";
+    color: var(--sft-highlight-color, #007bff);
+    font-weight: bold;
+    margin-right: 0.5em;
+}
+
+/* Improve screen reader flow for inline formatting */
+strong, b, em, i {
+    speak: normal;
+}
+
+/* Ensure tab panels are easily discoverable when focused */
+.sft-panel[role="tabpanel"]:focus {
+    position: relative;
+    z-index: 1;
+}
+
+/* ENHANCED: Focus styling for content within panels */
+.sft-panel:focus-within {
+    outline: 1px solid var(--sft-highlight-color, #007bff);
+    outline-offset: -1px;
 }
 
 /* General content panel - always visible */
@@ -110,6 +138,72 @@
     border-bottom: 1px solid #eee;
 }
 
+/* Panel visibility using data attributes */
+.sft-radio-group input[type="radio"][data-tab-index="0"]:checked ~ .sft-content .sft-panel[data-tab-index="0"],
+.sft-radio-group input[type="radio"][data-tab-index="1"]:checked ~ .sft-content .sft-panel[data-tab-index="1"],
+.sft-radio-group input[type="radio"][data-tab-index="2"]:checked ~ .sft-content .sft-panel[data-tab-index="2"],
+.sft-radio-group input[type="radio"][data-tab-index="3"]:checked ~ .sft-content .sft-panel[data-tab-index="3"],
+.sft-radio-group input[type="radio"][data-tab-index="4"]:checked ~ .sft-content .sft-panel[data-tab-index="4"],
+.sft-radio-group input[type="radio"][data-tab-index="5"]:checked ~ .sft-content .sft-panel[data-tab-index="5"],
+.sft-radio-group input[type="radio"][data-tab-index="6"]:checked ~ .sft-content .sft-panel[data-tab-index="6"],
+.sft-radio-group input[type="radio"][data-tab-index="7"]:checked ~ .sft-content .sft-panel[data-tab-index="7"],
+.sft-radio-group input[type="radio"][data-tab-index="8"]:checked ~ .sft-content .sft-panel[data-tab-index="8"],
+.sft-radio-group input[type="radio"][data-tab-index="9"]:checked ~ .sft-content .sft-panel[data-tab-index="9"] {
+    display: block;
+}
+
+/* ENHANCED: Accessibility improvements for content within panels */
+
+/* Make paragraphs within panels more accessible */
+.sft-panel p {
+    margin: 0.75em 0;
+    line-height: 1.5;
+}
+
+.sft-panel p:first-child {
+    margin-top: 0;
+}
+
+.sft-panel p:last-child {
+    margin-bottom: 0;
+}
+
+/* Enhanced code block accessibility */
+.sft-panel .highlight pre,
+.sft-panel code {
+    /* Ensure code blocks are focusable and readable */
+    border-radius: 4px;
+    position: relative;
+}
+
+.sft-panel .highlight pre:focus,
+.sft-panel code:focus {
+    outline: 2px solid var(--sft-highlight-color, #007bff);
+    outline-offset: 2px;
+    /* Ensure the content is announced to screen readers */
+    z-index: 1;
+}
+
+/* Make lists more accessible */
+.sft-panel ul,
+.sft-panel ol {
+    margin: 0.75em 0;
+    padding-left: 2em;
+}
+
+.sft-panel li {
+    margin: 0.25em 0;
+    line-height: 1.4;
+}
+
+/* Enhanced blockquote accessibility */
+.sft-panel blockquote {
+    margin: 1em 0;
+    padding: 0.5em 1em;
+    border-left: 4px solid #ddd;
+    background: #f9f9f9;
+}
+
 /* Screen reader only content */
 .sr-only {
     position: absolute;
@@ -123,6 +217,23 @@
     border: 0;
 }
 
+/* ENHANCED: Skip link for better keyboard navigation */
+.sft-container .skip-to-content {
+    position: absolute;
+    top: -40px;
+    left: 6px;
+    background: var(--sft-highlight-color, #007bff);
+    color: white;
+    padding: 8px;
+    text-decoration: none;
+    border-radius: 4px;
+    z-index: 1000;
+}
+
+.sft-container .skip-to-content:focus {
+    top: 6px;
+}
+
 /* Collapsible sections */
 .collapsible-section {
     border: 1px solid #e0e0e0;
@@ -164,14 +275,22 @@
     padding: 15px; 
 }
 
-/* High contrast mode support */
+/* ENHANCED: High contrast mode support with better visibility */
 @media (prefers-contrast: high) {
     .sft-radio-group input[type="radio"]:checked + label {
         border-bottom-width: 4px;
+        background: #000;
+        color: #fff;
     }
     
     .sft-radio-group input[type="radio"]:focus + label {
         box-shadow: 0 0 0 4px rgba(0, 0, 0, 0.8);
+        outline: 3px solid #fff;
+    }
+    
+    .sft-panel:focus {
+        outline: 3px solid #000;
+        background: #fff;
     }
 }
 
@@ -182,3 +301,24 @@
         transition: none;
     }
 }
+
+/* ENHANCED: Screen reader specific improvements */
+@media (prefers-reduced-motion: reduce) {
+    /* Ensure focus changes are immediate for screen reader users */
+    .sft-panel {
+        transition: none;
+    }
+}
+
+/* Force visibility for screen reader testing */
+@media (forced-colors: active) {
+    .sft-panel {
+        border: 1px solid ButtonText;
+    }
+    
+    .sft-radio-group input[type="radio"]:checked + label {
+        border: 2px solid Highlight;
+        background: Highlight;
+        color: HighlightText;
+    }
+}

sphinx_filter_tabs-1.2.6.dist-info/METADATA

@@ -0,0 +1,267 @@
+Metadata-Version: 2.4
+Name: sphinx-filter-tabs
+Version: 1.2.6
+Summary: A Sphinx extension for accessible, CSS-first filterable content tabs.
+Author-email: Aputsiak Niels Janussen <aputtu+sphinx@gmail.com>
+License: GNU General Public License v3.0
+Project-URL: Homepage, https://github.com/aputtu/sphinx-filter-tabs
+Project-URL: Repository, https://github.com/aputtu/sphinx-filter-tabs.git
+Project-URL: Issues, https://github.com/aputtu/sphinx-filter-tabs/issues
+Keywords: sphinx,extension,tabs,filter,documentation,css-only,accessibility,keyboard-navigation
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Sphinx<9.0,>=7.0
+Dynamic: license-file
+
+# Sphinx Filter Tabs Extension
+
+[![Tests and Docs Deployment](https://github.com/aputtu/sphinx-filter-tabs/actions/workflows/test.yml/badge.svg)](https://github.com/aputtu/sphinx-filter-tabs/actions/workflows/test.yml)
+[![PyPI version](https://img.shields.io/pypi/v/sphinx-filter-tabs.svg)](https://pypi.org/project/sphinx-filter-tabs/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-filter-tabs.svg)](https://pypi.org/project/sphinx-filter-tabs/)
+[![PyPI - License](https://img.shields.io/pypi/l/sphinx-filter-tabs.svg)](https://github.com/aputtu/sphinx-filter-tabs/blob/main/LICENSE)
+
+A robust Sphinx extension for creating accessible, filterable content tabs using pure CSS and semantic HTML.
+
+**📖 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. Perfect for showing code examples in multiple languages, installation instructions for different platforms, or any content that benefits from organized, filterable presentation.
+
+## Key Features
+
+- **Pure CSS Implementation:** Zero JavaScript dependencies for maximum compatibility and performance
+- **Fully Accessible:** WAI-ARIA compliant with native keyboard navigation and screen reader support
+- **Semantic HTML:** Uses standard form controls (radio buttons) for robust, predictable behavior
+- **Universal Compatibility:** Works in all environments where CSS is supported, including strict CSP policies
+- **Easy Customization:** Theme colors and styling through simple CSS custom properties
+- **Multiple Output Formats:** Graceful fallback to sequential content in PDF/LaTeX builds
+- **Proven Reliability:** Comprehensive test suite across multiple Python and Sphinx versions
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install sphinx-filter-tabs
+```
+
+### Enable the Extension
+
+Add to your `conf.py`:
+
+```python
+extensions = [
+    # ... your other extensions ...
+    'filter_tabs.extension',
+]
+```
+
+### Basic Usage
+
+```rst
+.. filter-tabs::
+
+    This content appears above all tabs.
+
+    .. tab:: Python
+
+        Install using pip:
+
+        .. code-block:: bash
+
+            pip install my-package
+
+    .. tab:: Conda (default)
+
+        Install using conda:
+
+        .. code-block:: bash
+
+            conda install my-package
+
+    .. tab:: From Source
+
+        Build from source:
+
+        .. code-block:: bash
+
+            git clone https://github.com/user/repo.git
+            cd repo
+            pip install -e .
+```
+
+## Configuration Options
+
+Add these optional settings to your `conf.py`:
+
+```python
+# Customize the active tab highlight color
+filter_tabs_highlight_color = '#007bff'  # Default: '#007bff'
+
+# Enable debug logging during development
+filter_tabs_debug_mode = False           # Default: False
+```
+
+## Advanced Usage
+
+### Custom Legend
+
+Override the auto-generated legend:
+
+```rst
+.. filter-tabs::
+   :legend: Select Your Installation Method
+
+   .. tab:: Quick Install
+      Content here...
+```
+
+### ARIA Labels for Accessibility
+
+Provide descriptive labels for screen readers:
+
+```rst
+.. filter-tabs::
+
+   .. tab:: CLI
+      :aria-label: Command line installation instructions
+      
+      Content for command line users...
+```
+
+### Nested Tabs
+
+Create complex layouts with nested tab groups:
+
+```rst
+.. filter-tabs::
+
+   .. tab:: Windows
+
+      Choose your package manager:
+
+      .. filter-tabs::
+
+         .. tab:: Chocolatey
+            choco install my-package
+
+         .. tab:: Scoop  
+            scoop install my-package
+```
+
+## How It Works
+
+This extension uses a **pure CSS architecture** with semantic HTML:
+
+- **Radio buttons** provide the selection mechanism (hidden but accessible)
+- **CSS `:checked` selectors** control panel visibility
+- **Fieldset/legend** structure provides semantic grouping
+- **ARIA attributes** enhance screen reader support
+- **Native keyboard navigation** works through standard form controls
+
+This approach ensures:
+- **Maximum compatibility** across all browsers and assistive technologies
+- **Better performance** with no JavaScript parsing or execution
+- **Enhanced security** for environments with strict Content Security Policies
+- **Simplified maintenance** with fewer dependencies and potential conflicts
+
+## Browser Support
+
+Works in all modern browsers that support:
+- CSS3 selectors (`:checked`, attribute selectors)
+- Basic ARIA attributes
+- HTML5 form elements
+
+This includes all browsers from the last 10+ years.
+
+## Development
+
+### Quick Setup
+
+```bash
+git clone https://github.com/aputtu/sphinx-filter-tabs.git
+cd sphinx-filter-tabs
+./scripts/setup_dev.sh
+```
+
+This creates a virtual environment and builds the documentation.
+
+### Development Commands
+
+```bash
+# Activate virtual environment
+source venv/bin/activate
+
+# Run tests
+pytest
+
+# Build documentation
+./scripts/dev.sh html
+
+# Run tests across multiple Sphinx versions
+tox
+
+# Clean build and start fresh
+./scripts/dev.sh clean-all
+
+# Export project structure for analysis
+./scripts/export-project.sh
+```
+
+### Testing
+
+The project includes comprehensive tests covering:
+- Basic tab functionality and content visibility
+- Accessibility features and ARIA compliance
+- Nested tabs and complex layouts
+- Multiple output formats (HTML, LaTeX)
+- Cross-browser compatibility
+
+Tests run automatically on:
+- Python 3.10, 3.12
+- Sphinx 7.0, 7.4, 8.0, 8.2
+- Multiple operating systems via GitHub Actions
+
+## Architecture
+
+The extension consists of three main components:
+
+- **`extension.py`** - Sphinx integration, directives, and node definitions
+- **`renderer.py`** - HTML generation and output formatting  
+- **`static/filter_tabs.css`** - Pure CSS styling and functionality
+
+This clean separation makes the code easy to understand, test, and maintain.
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new functionality
+4. Ensure all tests pass: `pytest`
+5. Submit a pull request
+
+## License
+
+GNU General Public License v3.0. See [LICENSE](LICENSE) for details.
+
+## Changelog
+
+See [CHANGELOG.md](docs/changelog.rst) for version history and migration notes.
+
+## Support
+
+- **Documentation**: https://aputtu.github.io/sphinx-filter-tabs/
+- **Issues**: https://github.com/aputtu/sphinx-filter-tabs/issues
+- **PyPI**: https://pypi.org/project/sphinx-filter-tabs/

sphinx_filter_tabs-1.2.6.dist-info/RECORD

@@ -0,0 +1,10 @@
+filter_tabs/__init__.py,sha256=VPpIhj4HaLeMX7ai7dZFkUm81ii2ePPGjCd9hsMjsN4,397
+filter_tabs/extension.py,sha256=6mna59Qg1zdk6Vn9eXU_CaaQg1yBq4ktx2jx9O01frM,18679
+filter_tabs/renderer.py,sha256=ublmQSoFewdPGRtEO7gLrxGqCZCjlooeom0wudx4phk,10100
+filter_tabs/static/filter_tabs.css,sha256=ZoiSWcn2YBEWgkQ-vPbIPHwQ7s2TG4aUikyxM1A8b9I,7956
+sphinx_filter_tabs-1.2.6.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+sphinx_filter_tabs-1.2.6.dist-info/METADATA,sha256=Wk2ZurjL5XIgRdHoyqtcjwFBGXft5K0aKIREoZWHAMA,7608
+sphinx_filter_tabs-1.2.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sphinx_filter_tabs-1.2.6.dist-info/entry_points.txt,sha256=za_bQcueY8AHyq7XnnjkW9X3C-LsZjeERVQ_ds7jV1A,62
+sphinx_filter_tabs-1.2.6.dist-info/top_level.txt,sha256=K0Iy-6EsYYdvlyXdsJT0SQg-BLDBgT5-Y8ZKy5SNAfc,12
+sphinx_filter_tabs-1.2.6.dist-info/RECORD,,

filter_tabs/static/filter_tabs.js

@@ -1,160 +0,0 @@
-// Progressive enhancement for keyboard navigation and accessibility.
-// This file ensures proper keyboard navigation and focus management,
-// while maintaining a CSS-only fallback.
-
-(function() {
-    'use strict';
-    
-    // Only enhance if the extension's HTML is present on the page.
-    if (!document.querySelector('.sft-container')) return;
-    
-    /**
-     * Moves focus to the content panel associated with a given radio button.
-     * This improves accessibility by directing screen reader users to the new content.
-     * @param {HTMLInputElement} radio The radio button that was selected.
-     */
-    function focusOnPanel(radio) {
-        if (!radio.checked) return;
-        
-        // Derive the panel's ID from the radio button's ID.
-        // e.g., 'filter-group-1-radio-0' becomes 'filter-group-1-panel-0'
-        const panelId = radio.id.replace('-radio-', '-panel-');
-        const panel = document.getElementById(panelId);
-        
-        if (panel) {
-            panel.focus();
-        }
-    }
-
-    /**
-     * Creates or updates a live region to announce tab changes to screen readers.
-     * @param {string} tabName The name of the selected tab.
-     */
-    function announceTabChange(tabName) {
-        // Create or find the live region for screen reader announcements.
-        let liveRegion = document.getElementById('tab-live-region');
-        if (!liveRegion) {
-            liveRegion = document.createElement('div');
-            liveRegion.id = 'tab-live-region';
-            liveRegion.setAttribute('role', 'status');
-            liveRegion.setAttribute('aria-live', 'polite');
-            liveRegion.setAttribute('aria-atomic', 'true');
-            // Hide the element visually but keep it accessible.
-            liveRegion.style.position = 'absolute';
-            liveRegion.style.left = '-10000px';
-            liveRegion.style.width = '1px';
-            liveRegion.style.height = '1px';
-            liveRegion.style.overflow = 'hidden';
-            document.body.appendChild(liveRegion);
-        }
-        
-        // Update the announcement text.
-        liveRegion.textContent = `${tabName} tab selected`;
-        
-        // Clear the announcement after a short delay to prevent clutter.
-        setTimeout(() => {
-            liveRegion.textContent = '';
-        }, 1000);
-    }
-
-    /**
-     * Initializes keyboard navigation for all filter-tab components on the page.
-     */
-    function initTabKeyboardNavigation() {
-        const containers = document.querySelectorAll('.sft-container');
-        
-        containers.forEach(container => {
-            const tabBar = container.querySelector('.sft-radio-group');
-            if (!tabBar) return;
-            
-            const radios = tabBar.querySelectorAll('input[type="radio"]');
-            const labels = tabBar.querySelectorAll('label');
-            
-            if (radios.length === 0 || labels.length === 0) return;
-            
-            // Make labels focusable to act as keyboard navigation targets.
-            labels.forEach(label => {
-                if (!label.hasAttribute('tabindex')) {
-                    label.setAttribute('tabindex', '0');
-                }
-            });
-
-            // Handle keyboard navigation on the tab labels.
-            labels.forEach((label, index) => {
-                label.addEventListener('keydown', (event) => {
-                    let targetIndex = index;
-                    let handled = false;
-                    
-                    switch (event.key) {
-                        case 'ArrowRight':
-                            event.preventDefault();
-                            targetIndex = (index + 1) % labels.length;
-                            handled = true;
-                            break;
-                            
-                        case 'ArrowLeft':
-                            event.preventDefault();
-                            targetIndex = (index - 1 + labels.length) % labels.length;
-                            handled = true;
-                            break;
-                            
-                        case 'Home':
-                            event.preventDefault();
-                            targetIndex = 0;
-                            handled = true;
-                            break;
-                            
-                        case 'End':
-                            event.preventDefault();
-                            targetIndex = labels.length - 1;
-                            handled = true;
-                            break;
-                            
-                        case 'Enter':
-                        case ' ':
-                            // Activate the associated radio button on Enter/Space.
-                            event.preventDefault();
-                            if (radios[index]) {
-                                radios[index].checked = true;
-                                radios[index].dispatchEvent(new Event('change', { bubbles: true }));
-                            }
-                            return;
-                            
-                        default:
-                            return;
-                    }
-                    
-                    if (handled) {
-                        // Move focus to the target label and activate its radio button.
-                        labels[targetIndex].focus();
-                        if (radios[targetIndex]) {
-                            radios[targetIndex].checked = true;
-                            radios[targetIndex].dispatchEvent(new Event('change', { bubbles: true }));
-                        }
-                    }
-                });
-            });
-            
-            // Add listeners for announcements and focus management.
-            radios.forEach((radio, index) => {
-                radio.addEventListener('change', () => {
-                    if (radio.checked) {
-                        // Announce the change to screen readers.
-                        if (labels[index]) {
-                            announceTabChange(labels[index].textContent.trim());
-                        }
-                        // Move focus to the newly visible panel.
-                        focusOnPanel(radio);
-                    }
-                });
-            });
-        });
-    }
-    
-    // Initialize the script once the DOM is ready.
-    if (document.readyState === 'loading') {
-        document.addEventListener('DOMContentLoaded', initTabKeyboardNavigation);
-    } else {
-        initTabKeyboardNavigation();
-    }
-})();

sphinx_filter_tabs-1.2.2.dist-info/METADATA

@@ -1,70 +0,0 @@
-Metadata-Version: 2.4
-Name: sphinx-filter-tabs
-Version: 1.2.2
-Summary: A Sphinx extension for accessible, CSS-first filterable content tabs.
-Author-email: Aputsiak Niels Janussen <aputtu+sphinx@gmail.com>
-License: GNU General Public License v3.0
-Project-URL: Homepage, https://github.com/aputtu/sphinx-filter-tabs
-Project-URL: Repository, https://github.com/aputtu/sphinx-filter-tabs.git
-Project-URL: Issues, https://github.com/aputtu/sphinx-filter-tabs/issues
-Keywords: sphinx,extension,tabs,filter,documentation,css-only,accessibility,keyboard-navigation
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: Sphinx :: Extension
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Documentation :: Sphinx
-Classifier: Topic :: Software Development :: Documentation
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: Sphinx<9.0,>=7.0
-Dynamic: license-file
-
-# Sphinx Filter Tabs Extension
-
-[![Tests and Docs Deployment](https://github.com/aputtu/sphinx-filter-tabs/actions/workflows/test.yml/badge.svg)](https://github.com/aputtu/sphinx-filter-tabs/actions/workflows/test.yml)
-[![PyPI version](https://img.shields.io/pypi/v/sphinx-filter-tabs.svg)](https://pypi.org/project/sphinx-filter-tabs/)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-filter-tabs.svg)](https://pypi.org/project/sphinx-filter-tabs/)
-[![PyPI - License](https://img.shields.io/pypi/l/sphinx-filter-tabs.svg)](https://github.com/aputtu/sphinx-filter-tabs/blob/main/LICENSE)
-
-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`:
-```bash
-pip install sphinx-filter-tabs
-```
-
-## Development
-
-1. You can install a local version of the Sphinx with extension using:
-```bash
-./scripts/setup_dev.sh # Initially cleans previous folders in _docs/build  and venv.
-```
-
-Command to enter venv is provided.
-
-2. Once inside virtual environment, you can use following commands:
-```bash
-pytest # Runs test suite on configured version of Sphinx.
-tox # Check across multiple Sphinx versions. Manual install of tox required.
-./scripts/export-project.sh # Outputs directory structure and code to txt
-./dev.sh [options] # Allows for faster generation for html, pdf, clean up
-```

sphinx_filter_tabs-1.2.2.dist-info/RECORD

@@ -1,11 +0,0 @@
-filter_tabs/__init__.py,sha256=VPpIhj4HaLeMX7ai7dZFkUm81ii2ePPGjCd9hsMjsN4,397
-filter_tabs/extension.py,sha256=Dspt9r8TVoYChHFvGsncuV01GEga7BOOsPaMwYdMQcg,18014
-filter_tabs/renderer.py,sha256=e_nUV67ojDHfEXWB7jFkclzy4fOLotluKBg573fGng8,10436
-filter_tabs/static/filter_tabs.css,sha256=V7y8BCp0UTQ1KXZNeIYtfz0Zt6b-uJPKYeXcx4PHz4A,3913
-filter_tabs/static/filter_tabs.js,sha256=-d_TJREyNxu9TtQNDLvQ0G5qCVWR2TxwrWmApGs2CBo,6559
-sphinx_filter_tabs-1.2.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-sphinx_filter_tabs-1.2.2.dist-info/METADATA,sha256=qX7ycCD1JfwXgju5W5pnlhoN1p09cnR_U9yUQZrFpBk,3483
-sphinx_filter_tabs-1.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-sphinx_filter_tabs-1.2.2.dist-info/entry_points.txt,sha256=za_bQcueY8AHyq7XnnjkW9X3C-LsZjeERVQ_ds7jV1A,62
-sphinx_filter_tabs-1.2.2.dist-info/top_level.txt,sha256=K0Iy-6EsYYdvlyXdsJT0SQg-BLDBgT5-Y8ZKy5SNAfc,12
-sphinx_filter_tabs-1.2.2.dist-info/RECORD,,