index.md

sphinx-togglebutton

A small sphinx extension to add "toggle button" elements to sections of your page. For example:

Collapse admonitions

You can collapse admonitions (notes, warnings, etc) so that their content is hidden until users click the admonition title.

:::{admonition} Example: click this title to toggle the content :class: dropdown You can toggle any admonition to hide its content behind a user click! Do so by adding a dropdown class to the admonition, like this:

```{note}
:class: dropdown

Some content
```

:::

See {ref}use:admonition-toggles for more information.

Hide any content behind a toggle button

You can also hide arbitrary content behind a toggle button. When users press the button, they will see the content. For example:

::::{toggle}

This is a toggled content block! It was added like this:

```{toggle}
This is a toggled content block!
```

::::

You can either do this with a {toggle} directive, or by adding a toggle CSS class to any elements you'd like hidden behind a toggle button.

See for more details.

:::{admonition} Check out sphinx-design as well! :class: tip

For a bootstrap-based "dropdown" directive that uses pure CSS, check out Sphinx Design :::

Installation

You can install sphinx-togglebutton with pip:

pip install sphinx-togglebutton

Then, activate it in your sphinx build by adding it to your conf.py configuration file, like so:

E.g.:

extensions = [
    ...
    'sphinx_togglebutton'
    ...
]

See {ref}usage for information about how to use sphinx-togglebutton.

:maxdepth: 2
use
reference/index
reference/notebooks
changelog