https://github.com/sphinx-contrib/sphinxcontrib-details-directive
https://github.com/sphinx-contrib/sphinxcontrib-details-directive
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sphinx-contrib/sphinxcontrib-details-directive
- Owner: sphinx-contrib
- License: apache-2.0
- Created: 2019-09-22T13:20:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-21T20:28:53.000Z (almost 4 years ago)
- Last Synced: 2025-04-18T00:42:42.564Z (23 days ago)
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 5
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
===============================
sphinxcontrib-details-directive
===============================
``details`` directive for Sphinx
It enables ``details`` directive as an element to represent ```` 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 ```` block containing following contents::
.. details:: summary of the detail block
description of the details block.
blah blah blah
It will be rendered with ```` 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.