Skip to main content

"details" directive for Sphinx

Project description

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.

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

sphinxcontrib-details-directive-0.1.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl (10.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-details-directive-0.1.0.tar.gz.

File metadata

  • Download URL: sphinxcontrib-details-directive-0.1.0.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for sphinxcontrib-details-directive-0.1.0.tar.gz
Algorithm Hash digest
SHA256 78bd6a67f786a21868abf0e6a5973340d7e7a6fd71b1890de9c856f92877b38b
MD5 10305183fcc0c1cd52defcb5e2dffec4
BLAKE2b-256 620a2de87a4f6e0e33415692ed4b03e0b7dfde7d91a691d1486c1577191f875c

See more details on using hashes here.

File details

Details for the file sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ed4d4f47b36e3e905601d425945cbe9d50d4cbcf9964bbf9c863d5a983fb7bf6
MD5 3872f2af0a908ddde00e3983b443e78b
BLAKE2b-256 109e9cb96fbdca829ba3eb094d966d0f48bb018215e73f96c8750088e73f2f19

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page