{"id":23251544,"url":"https://github.com/dgarcia360/sphinx-collapse","last_synced_at":"2025-08-20T09:31:12.590Z","repository":{"id":38213336,"uuid":"449683570","full_name":"dgarcia360/sphinx-collapse","owner":"dgarcia360","description":"Sphinx extension to hide large amounts of content","archived":false,"fork":false,"pushed_at":"2024-03-26T22:52:18.000Z","size":42,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-28T20:17:59.231Z","etag":null,"topics":["directive","documentation","extension","sphinx","sphinx-doc"],"latest_commit_sha":null,"homepage":"https://sphinx-collapse.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dgarcia360.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-19T12:32:13.000Z","updated_at":"2024-09-10T23:28:57.000Z","dependencies_parsed_at":"2022-07-12T17:12:34.797Z","dependency_job_id":null,"html_url":"https://github.com/dgarcia360/sphinx-collapse","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgarcia360%2Fsphinx-collapse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgarcia360%2Fsphinx-collapse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgarcia360%2Fsphinx-collapse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dgarcia360%2Fsphinx-collapse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dgarcia360","download_url":"https://codeload.github.com/dgarcia360/sphinx-collapse/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230408140,"owners_count":18220980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["directive","documentation","extension","sphinx","sphinx-doc"],"created_at":"2024-12-19T09:18:52.318Z","updated_at":"2024-12-19T09:18:52.832Z","avatar_url":"https://github.com/dgarcia360.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"sphinx-collapse\n===============\n\nThe ``sphinx-collapse`` extension enhances Sphinx documentation by introducing collapsible sections.\nThis feature allows documentation authors to create toggles for hiding and revealing detailed content, making documents more manageable and navigable for readers.\n\nExample:\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\nAdd the collapse directive in your reStructuredText content. Here's a basic example:\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\nExample output:\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 \u003chttps://sphinx-collapse.readthedocs.io/en/latest/contribute.html\u003e`_ for details on our code of conduct and development process.\n\nLicense\n-------\n\nCopyright (c) 2022 - present David Garcia (`@dgarcia360 \u003chttps://twitter.com/dgarcia360\u003e`_).\n\nLicensed under the `MIT License \u003chttps://github.com/dgarcia360/sphinx-collapse/blob/main/LICENSE.md\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdgarcia360%2Fsphinx-collapse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdgarcia360%2Fsphinx-collapse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdgarcia360%2Fsphinx-collapse/lists"}