Skip to main content

Sphinx extension that, on pages with dropdown elements, adds a button to open/close all dropdowns simultaneously.

Project description

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. The MANUAL.md of the branch main is also part of the TeachBooks manual as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the GitHub repository. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_dropdown_toggle-1.3.2.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_dropdown_toggle-1.3.2-py3-none-any.whl (49.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_dropdown_toggle-1.3.2.tar.gz.

File metadata

  • Download URL: sphinx_dropdown_toggle-1.3.2.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_dropdown_toggle-1.3.2.tar.gz
Algorithm Hash digest
SHA256 af721ac3dea9bb965ee886dca1c8f1095c9ab0baff9520824833073c1659b2bb
MD5 65fdc4d28cbe4f347e3800ad6ae3cf0f
BLAKE2b-256 a61c423b1b51486bcbbe8a9043e5fae85826e1a76d1e18154fc5b8d14deafcb4

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_dropdown_toggle-1.3.2.tar.gz:

Publisher: python-publish.yml on TeachBooks/Sphinx-Dropdown-Toggle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_dropdown_toggle-1.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_dropdown_toggle-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1ebc9db830d180ea51db253732cfd2d13ef3eaf7247abeaa889f8c40aef19214
MD5 bf209507335266cbe47f5158724bcc0f
BLAKE2b-256 8857a1e96466acec41fb994ad67fac3ef96e9c6c2f802d4018dc624b4eb1ee8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_dropdown_toggle-1.3.2-py3-none-any.whl:

Publisher: python-publish.yml on TeachBooks/Sphinx-Dropdown-Toggle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page