Overview
========

``sphinx-collapse`` is a Sphinx extension that lets you add collapsible content to your documentation.

Collapsibles are useful to hide large amounts of content:

.. collapse:: Click here

   Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Features
--------

**Hide content**

Toggle the visibility of content with a Sphinx directive tailored for this purpose.

**Minimal code**

The library does not use JavaScript nor relies on third-party frameworks such as Bootstrap, Tailwind CSS, or Foundation.

**Configurable**

You can then customize the style of the collapsible directive using options or overriding the CSS.

Get started
-----------

.. toctree::
   :maxdepth: 1

   installation
   usage
   reference
   who-is-using-it
   contribute

Sponsors
--------

This project is sponsored by `Scylla <https://www.scylladb.com/>`_, The Real-Time Big Data Database.

License
-------

Copyright (c) 2022 - present David Garcia (`@dgarcia360 <https://twitter.com/dgarcia360>`_).

Licensed under the `MIT License <https://github.com/dgarcia360/sphinx-collapse/blob/main/LICENSE.md>`_.