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.0.1.tar.gz (7.0 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.0.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_dropdown_toggle-1.0.1.tar.gz
  • Upload date:
  • Size: 7.0 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.0.1.tar.gz
Algorithm Hash digest
SHA256 fcc49920f3ffbe4bc1eafefa6278977d7f16b80c8cb82f836e760b560303b205
MD5 88bf5222e1fb3d7cd6788d05690e5252
BLAKE2b-256 42cfb6c2ac447a498dda9dbc0138ee39211036bf2a298794e2aacf0e9287e023

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_dropdown_toggle-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f263a3789c05696933d93c6e51671b576cd5f7ca4288d411a4471717373d13a6
MD5 095f9d1bb17228cf6f36d5ed93c42ad5
BLAKE2b-256 e48b836011529accbc02fe1bb2d490df13a6e955824790388c27605fa73efcad

See more details on using hashes here.

Provenance

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