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.0.tar.gz (15.1 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.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_dropdown_toggle-1.3.0.tar.gz
  • Upload date:
  • Size: 15.1 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.0.tar.gz
Algorithm Hash digest
SHA256 ba181271fe4fc9202e2e0e1c344f10797b4101682613d00a19c72d852d106bed
MD5 c9a869384cdbb4e1d1ba8c2501b9e43a
BLAKE2b-256 d25676c669653fa337ad50469d368af563e25acaaa65f60206a67586ffb64e62

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_dropdown_toggle-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 495e3deb1e702977694fac6b91450e5faeec26d307dd1a7f6804aa99289aaf32
MD5 b83a3a184118e99835f044508fe87cb7
BLAKE2b-256 0c85972312334d3c2de02e044338778a39f54194e9e5a3f0324d8a2d96a15047

See more details on using hashes here.

Provenance

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