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


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-details-directive, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl (10.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size sphinxcontrib-details-directive-0.1.0.tar.gz (8.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page