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.1.tar.gz (17.5 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.1-py3-none-any.whl (49.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_dropdown_toggle-1.3.1.tar.gz
Algorithm Hash digest
SHA256 1f13b1174a1820a01363113e9be02fb818581c29322eaa88eab86b85f695c376
MD5 4e372c5f88e856be9af643aadea7c692
BLAKE2b-256 753e888fce046b3633354bb5c48afa3d17c91c0d051f29dbceffb65d7205e418

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_dropdown_toggle-1.3.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_dropdown_toggle-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9234e22de33ef748b0ddcb1e586dfec4f47b2d2ec733ca43939ab1d2f6e1907a
MD5 0da066dacc4b46b47a7f459c4a9ceaa1
BLAKE2b-256 68263f9f283652c7559e22d288e1dd4f88d7743c5f33310c3e51902d453cca2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_dropdown_toggle-1.3.1-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