Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.09 KB

togglebutton.rst

File metadata and controls

56 lines (34 loc) · 1.09 KB

Sphinx Togglebutton

About

sphinx-togglebutton is a small Sphinx extension to make it possible to add a "toggle button" to sections of your page. This allows you to:

  • Collapse Sphinx admonitions (notes, warnings, etc.) so that their content is hidden until users click a toggle button.
  • Collapse arbitrary chunks of content on your page with a collapse directive.

Examples

Collapsed

The default version is to display the collapsed variant of the element.

Note

This is my note.

Opened

You may also show the content by default.

Note

This is my note.

Container

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!

https://media.giphy.com/media/mW05nwEyXLP0Y/giphy.gif