Metadata-Version: 2.4
Name: sphinx-dropdown-toggle
Version: 1.3.1
Summary: Sphinx extension that, on pages with dropdown elements, adds a button to open/close all dropdowns simultaneously.
Author-email: Dennis den Ouden-van der Horst <d.denouden-vanderhorst@tudelft.nl>, Tom van Woudenberg <T.R.vanWoudenberg@tudelft.nl>
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: sphinx
Description-Content-Type: text/markdown

# Dropdown Toggle

## Introduction

This Sphinx extension adds a button to open/close all dropdowns simultaneously, provided at least one dropdown is present.

## Installation
To install the Sphinx-Dropdown-Toggle, follow these steps:

**Step 1: Install the Package**

Install the `Sphinx-Dropdown-Toggle` package using `pip`:
```
pip install sphinx-dropdown-toggle
```

**Step 2: Add to `requirements.txt`**

Make sure that the package is included in your project's `requirements.txt` to track the dependency:
```
sphinx-dropdown-toggle
```

**Step 3: Enable in `_config.yml`**

In your `_config.yml` file, add the extension to the list of Sphinx extra extensions:
```
sphinx: 
    extra_extensions:
        - sphinx_dropdown_toggle
```

## Contribute

This tool's repository is stored on [GitHub](https://github.com/TeachBooks/Sphinx-Dropdown-Toggle). The `MANUAL.md` of the branch `main` is also part of the [TeachBooks manual](https://teachbooks.io/manual/external/Sphinx-Dropdown-Toggle/README.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/Sphinx-Dropdown-Toggle). To update the `MANUAL.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitHub repository of the manual](https://github.com/TeachBooks/manual).
