Skip to main content

details directive for Sphinx

It enables details directive as an element to represent <details> element in HTML output. It will be converted into mere paragraphs in other output formats.

## Install

Install the package via pip ` $ pip install sphinxcontrib-details-directive `

And append sphinxcontrib.details.directive to extensions list in your conf.py. ` extensions = ['sphinxcontrib.details.directive] `

## Directive

details

details directive create a <details> block containing following contents:

 .. details:: summary of the detail block

    description of the details block.
    blah blah blah

It will be rendered with ``<details>`` tag in HTML output.  On the other hand, for
other output formats, it will be rendered as mere paragraphs.

``:open:`` flag is allowed to indicate the details block is opened by default.

Metadata

Release files for sphinxcontrib-details-directive 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxcontrib-details-directive 0.1.0
File Size Uploaded
sphinxcontrib-details-directive-0.1.0.tar.gz 8.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-details-directive 0.1.0
File Interpreter ABI Platform
sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 18.7 kB

Release files / sphinxcontrib-details-directive-0.1.0.tar.gz

Download URL sphinxcontrib-details-directive-0.1.0.tar.gz
Size 8.0 kB
Tags Source
SHA-256 checksum
How to use checksums
78bd6a67f786a21868abf0e6a5973340d7e7a6fd71b1890de9c856f92877b38b
BLAKE2b-256 checksum
How to use checksums
620a2de87a4f6e0e33415692ed4b03e0b7dfde7d91a691d1486c1577191f875c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4

Release files / sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl

Download URL sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl
Size 10.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
ed4d4f47b36e3e905601d425945cbe9d50d4cbcf9964bbf9c863d5a983fb7bf6
BLAKE2b-256 checksum
How to use checksums
109e9cb96fbdca829ba3eb094d966d0f48bb018215e73f96c8750088e73f2f19
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page