sphinx-togglebutton
Toggle page content and collapse admonitions in Sphinx.
Decision gist · record as of 2026-08-14
Yes. The package is actively maintained, has no known vulnerabilities, uses a permissive MIT License, and solves a common documentation UX problem with low install friction. It's a lightweight, focused extension that integrates cleanly into Sphinx workflows.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low install friction with a pure-Python wheel distribution.
- The package is actively maintained with a recent release and no known vulnerabilities.
- Depends on standard Sphinx ecosystem packages.
License · maintenance · safety
MIT License (permissive) — MIT License permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial documentation projects.
last release 2026-03-27 (140 days) · last repo commit 2026-03-27 · 47 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 519,405 downloads/mo, #6,217 on PyPI
Alternatives
Verify before relying
pip install sphinx-togglebutton
Then in conf.py:
extensions = ['sphinx_togglebutton']
In your .rst file:
.. note::
:class: dropdown
This is my note.- Whether the extension works with all current Sphinx versions or has specific version constraints
- Performance impact when toggling large numbers of collapsed sections
What it is and what it does
sphinx-togglebutton is a Sphinx extension that adds interactive collapse/expand functionality to your documentation. It lets you hide admonitions (notes, warnings, etc.) behind toggle buttons so readers only see content when they click, and also provides a generic container directive for collapsing arbitrary sections. The extension supports showing content expanded or collapsed by default via CSS classes, and includes internationalization for toggle button labels across many languages.
You install it by adding it to your Sphinx conf.py extensions list, then mark admonitions with the `dropdown` class or use container directives with toggle classes. It requires sphinx and docutils as runtime dependencies and has no compiled components, making it straightforward to install and use in any Sphinx-based documentation workflow.
Use it for
- Hide verbose admonitions (warnings, notes) in documentation to reduce visual clutter while keeping them accessible
- Collapse code examples or implementation details that readers may not need on first read
- Create expandable FAQ or troubleshooting sections where each answer starts hidden
- Organize long documentation pages by collapsing optional or advanced content sections
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The package is actively maintained, has no known vulnerabilities, uses a permissive MIT License, and solves a common documentation UX problem with low install friction. It's a lightweight, focused extension that integrates cleanly into Sphinx workflows.
Install
sphinx-togglebutton on PyPI
Before you install
Low install friction with a pure-Python wheel distribution. The package is actively maintained with a recent release and no known vulnerabilities. Depends on standard Sphinx ecosystem packages.
License in practice
MIT License permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial documentation projects.
Quickstart
pip install sphinx-togglebutton
Then in conf.py:
extensions = ['sphinx_togglebutton']
In your .rst file:
.. note::
:class: dropdown
This is my note.Verify before relying
- Whether the extension works with all current Sphinx versions or has specific version constraints
- Performance impact when toggling large numbers of collapsed sections
Package facts
| License | MIT License permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagessetuptoolswheelsphinxdocutils |
| Maintenance | Actively maintained 140 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 519,405 / month, #6,217 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT License |
Evidence: sphinx_togglebutton-0.4.5-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx collapsible admonitions”
- sphinx-togglebuttonA Sphinx extension that adds collapsible toggle buttons to…
- markdown-calloutsAdds a cleaner block-level syntax to Markdown for creating…
- sphinxcontrib-log-cabinetA Sphinx extension that organizes changelog entries generated by…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also sphinx-panels · sphinx-copybutton · sphinx-toggleprompt · sphinxcontrib-log-cabinet · sphinx-substitution-extensions · sphinx-jinja · sphinx-tabs · sphinxcontrib-video · sphinx-rtd-dark-mode · changelog