sphinx-togglebutton¶
A small sphinx extension to make it possible to add a “toggle button” to sections of your page.
For example, click the “-” button to the right:
Note
Here’s a toggled admonition
It was created with this code:
.. note:: Here's a toggled admonition
:class: toggle
(admonition body here)
And here’s a code block:
a = "wow, very python"
print("this code should be toggle-able!")
Usage¶
In your conf.py
configuration file, add sphinx_togglebutton
to your extensions list.
E.g.:
extensions = [
...
'sphinx_togglebutton'
...
]
Now, whenever you wish for an admonition to be toggle-able, add the
:class: toggle
parameter to the admonition directive that you use.
For example, this code would create a toggle-able “note” admonition:
.. note::
:class: toggle
This is my note.
Here’s how it looks:
Note
This is my note.
Clicking on the toggle button will toggle the item’s visibility.
You may also hide the content by default. To do so, add the toggle
class as well as a toggle-hidden
class, like so:
.. note::
:class: toggle, toggle-hidden
This is my note.
This will generate the following block:
Note
This is my note.
You can also use containers to add arbitrary toggle-able code. For example, here’s a container with an image inside:
Look at that, an image!

Here’s how they look right after one another:
Note
This is my note.
Note
This is my second.