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.2.0.tar.gz (8.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.2.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_dropdown_toggle-1.2.0.tar.gz
  • Upload date:
  • Size: 8.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.2.0.tar.gz
Algorithm Hash digest
SHA256 cc173df6f6b4cc290a6e0d1ae17c740fbec846275122341dfed5cc32030f6bb7
MD5 6a5bc306540628f4b787abc111f7ce19
BLAKE2b-256 ced9cb62202e2f37fb10bf5b1180dda19f1047e7a58d514cdc4f0fb817d544ff

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_dropdown_toggle-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69da420787d44dc720ba4ae3b7f7ce27627072e4cc0eb4da5949ebbee0f7fe82
MD5 f1b267ee11c6dafb958d1397ab81dd7b
BLAKE2b-256 0dd5ffa20e7aeedc0419534900c717a042394706d71bb93431fe3f90e2d071ca

See more details on using hashes here.

Provenance

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