sphinx-collapse
===============
``sphinx-collapse`` is a Sphinx extension that lets you add collapsible content to your documentation.
Collapsibles are useful to hide large amounts of content:
.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-collapse/main/docs/source/_static/example.png
Features
--------
**Hide content**
Toggle the visibility of content with a Sphinx directive tailored for this purpose.
**Minimal code**
The library does not use JavaScript nor relies on third-party frameworks such as Bootstrap, Tailwind CSS, or Foundation.
**Configurable**
Customize the style of the collapsible directive using options or overriding the CSS.
Installation
------------
#. Install ``sphinx-collapse`` using PIP.
.. code-block:: bash
pip install sphinx-collapse
#. Add the extension to your Sphinx project ``conf.py`` file.
.. code-block:: python
extensions = ['sphinx_collapse']
Usage
-----
Using the directive:
.. code-block:: rst
.. collapse:: Click here
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Renders:
.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-collapse/main/docs/source/_static/example.png
Check out the full documentation for more customizable options at https://sphinx-collapse.readthedocs.io/
Contributing
------------
We encourage public contributions!
Please review `CONTRIBUTING <https://sphinx-collapse.readthedocs.io/en/latest/contribute.html>`_ for details on our code of conduct and development process.
License
-------
Copyright (c) 2022 - present David Garcia (`@dgarcia360 <https://twitter.com/dgarcia360>`_).
Licensed under the `MIT License <https://github.com/dgarcia360/sphinx-collapse/blob/main/LICENSE.md>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/dgarcia360/sphinx-collapse",
"name": "sphinx_collapse",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "David Garcia",
"author_email": "hi@davidgarcia.dev",
"download_url": "https://files.pythonhosted.org/packages/e7/02/183559e508906f7282d4dd6ccbf443efddaa3114b7f6fab425949b37a003/sphinx_collapse-0.1.3.tar.gz",
"platform": null,
"description": "sphinx-collapse\n===============\n\n``sphinx-collapse`` is a Sphinx extension that lets you add collapsible content to your documentation.\n\nCollapsibles are useful to hide large amounts of content:\n\n.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-collapse/main/docs/source/_static/example.png\n\nFeatures\n--------\n\n**Hide content**\n\nToggle the visibility of content with a Sphinx directive tailored for this purpose.\n\n**Minimal code**\n\nThe library does not use JavaScript nor relies on third-party frameworks such as Bootstrap, Tailwind CSS, or Foundation.\n\n**Configurable**\n\nCustomize the style of the collapsible directive using options or overriding the CSS.\n\nInstallation\n------------\n\n#. Install ``sphinx-collapse`` using PIP.\n\n .. code-block:: bash\n\n pip install sphinx-collapse\n\n\n#. Add the extension to your Sphinx project ``conf.py`` file.\n\n .. code-block:: python\n\n extensions = ['sphinx_collapse']\n\nUsage\n-----\n\nUsing the directive:\n\n.. code-block:: rst\n\n .. collapse:: Click here\n\n Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n\nRenders:\n\n.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-collapse/main/docs/source/_static/example.png\n\nCheck out the full documentation for more customizable options at https://sphinx-collapse.readthedocs.io/\n\nContributing\n------------\n\nWe encourage public contributions!\nPlease review `CONTRIBUTING <https://sphinx-collapse.readthedocs.io/en/latest/contribute.html>`_ for details on our code of conduct and development process.\n\nLicense\n-------\n\nCopyright (c) 2022 - present David Garcia (`@dgarcia360 <https://twitter.com/dgarcia360>`_).\n\nLicensed under the `MIT License <https://github.com/dgarcia360/sphinx-collapse/blob/main/LICENSE.md>`_.\n",
"bugtrack_url": null,
"license": null,
"summary": "Collapse extension for Sphinx.",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/dgarcia360/sphinx-collapse"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2f2f5889082a6a535aa8613a327308582914517082967583ad45586b7d61c145",
"md5": "55618339eedd66ac376bae006a8b0f24",
"sha256": "85fadb2ec8769b93fd04276538668fa96239ef60c20c4a9eaa3e480387a6e65b"
},
"downloads": -1,
"filename": "sphinx_collapse-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55618339eedd66ac376bae006a8b0f24",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4688,
"upload_time": "2024-02-22T15:24:29",
"upload_time_iso_8601": "2024-02-22T15:24:29.365296Z",
"url": "https://files.pythonhosted.org/packages/2f/2f/5889082a6a535aa8613a327308582914517082967583ad45586b7d61c145/sphinx_collapse-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e702183559e508906f7282d4dd6ccbf443efddaa3114b7f6fab425949b37a003",
"md5": "d41cc8fc519d75a6595c201f46a6d496",
"sha256": "cae141e6f03ecd52ed246a305a69e1b0d5d05e6cdf3fe803d40d583ad6ad895a"
},
"downloads": -1,
"filename": "sphinx_collapse-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "d41cc8fc519d75a6595c201f46a6d496",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 18540,
"upload_time": "2024-02-22T15:24:38",
"upload_time_iso_8601": "2024-02-22T15:24:38.735483Z",
"url": "https://files.pythonhosted.org/packages/e7/02/183559e508906f7282d4dd6ccbf443efddaa3114b7f6fab425949b37a003/sphinx_collapse-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 15:24:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dgarcia360",
"github_project": "sphinx-collapse",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx_collapse"
}
JSON
