===============================
sphinxcontrib-details-directive
===============================
``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.
Raw data
{
"_id": null,
"home_page": "https://github.com/tk0miya/sphinxcontrib-details-directive/",
"name": "sphinxcontrib-details-directive",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Takeshi KOMIYA",
"author_email": "i.tkomiya@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/62/0a/2de87a4f6e0e33415692ed4b03e0b7dfde7d91a691d1486c1577191f875c/sphinxcontrib-details-directive-0.1.0.tar.gz",
"platform": "",
"description": "===============================\nsphinxcontrib-details-directive\n===============================\n\n``details`` directive for Sphinx\n\nIt enables ``details`` directive as an element to represent ``<details>`` element in HTML output.\nIt will be converted into mere paragraphs in other output formats.\n\n## Install\n\nInstall the package via pip\n```\n$ pip install sphinxcontrib-details-directive\n```\n\nAnd append `sphinxcontrib.details.directive` to extensions list in your conf.py.\n```\nextensions = ['sphinxcontrib.details.directive]\n```\n\n## Directive\n\n**details**\n\n ``details`` directive create a ``<details>`` block containing following contents::\n\n .. details:: summary of the detail block\n\n description of the details block.\n blah blah blah\n\n It will be rendered with ``<details>`` tag in HTML output. On the other hand, for\n other output formats, it will be rendered as mere paragraphs.\n\n ``:open:`` flag is allowed to indicate the details block is opened by default.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "\"details\" directive for Sphinx",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/tk0miya/sphinxcontrib-details-directive/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "109e9cb96fbdca829ba3eb094d966d0f48bb018215e73f96c8750088e73f2f19",
"md5": "3872f2af0a908ddde00e3983b443e78b",
"sha256": "ed4d4f47b36e3e905601d425945cbe9d50d4cbcf9964bbf9c863d5a983fb7bf6"
},
"downloads": -1,
"filename": "sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3872f2af0a908ddde00e3983b443e78b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 10724,
"upload_time": "2019-09-22T13:24:25",
"upload_time_iso_8601": "2019-09-22T13:24:25.279209Z",
"url": "https://files.pythonhosted.org/packages/10/9e/9cb96fbdca829ba3eb094d966d0f48bb018215e73f96c8750088e73f2f19/sphinxcontrib_details_directive-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "620a2de87a4f6e0e33415692ed4b03e0b7dfde7d91a691d1486c1577191f875c",
"md5": "10305183fcc0c1cd52defcb5e2dffec4",
"sha256": "78bd6a67f786a21868abf0e6a5973340d7e7a6fd71b1890de9c856f92877b38b"
},
"downloads": -1,
"filename": "sphinxcontrib-details-directive-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "10305183fcc0c1cd52defcb5e2dffec4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7969,
"upload_time": "2019-09-22T13:24:27",
"upload_time_iso_8601": "2019-09-22T13:24:27.707615Z",
"url": "https://files.pythonhosted.org/packages/62/0a/2de87a4f6e0e33415692ed4b03e0b7dfde7d91a691d1486c1577191f875c/sphinxcontrib-details-directive-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-09-22 13:24:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tk0miya",
"github_project": "sphinxcontrib-details-directive",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "sphinxcontrib-details-directive"
}
JSON
