pax_global_header 0000666 0000000 0000000 00000000064 15150354234 0014514 g ustar 00root root 0000000 0000000 52 comment=ea7a5fd6b93be33be214be33427625336f7aaa8a
dgarcia360-sphinx-collapse-ea7a5fd/ 0000775 0000000 0000000 00000000000 15150354234 0017224 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/.flake8 0000664 0000000 0000000 00000000036 15150354234 0020376 0 ustar 00root root 0000000 0000000 [flake8]
max-line-length = 88
dgarcia360-sphinx-collapse-ea7a5fd/.github/ 0000775 0000000 0000000 00000000000 15150354234 0020564 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/.github/dependabot.yml 0000664 0000000 0000000 00000000436 15150354234 0023417 0 ustar 00root root 0000000 0000000 version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
# Maintain dependencies for Poetry
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "daily"
dgarcia360-sphinx-collapse-ea7a5fd/.github/workflows/ 0000775 0000000 0000000 00000000000 15150354234 0022621 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/.github/workflows/ci.yml 0000664 0000000 0000000 00000001257 15150354234 0023744 0 ustar 00root root 0000000 0000000 ---
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.8]
steps:
- uses: actions/checkout@v4
- name: "Set up Python"
uses: actions/setup-python@v5.0.0
with:
python-version: ${{ matrix.python-version }}
- name: "Install dependencies"
run: |
python -m pip install .[test]
# - name: "Lint code"
# run: |
# pre-commit run --all-files
- name: "Build sample"
run: |
make -C docs dirhtml
- name: "Run tests"
run: |
pytest -vvv
dgarcia360-sphinx-collapse-ea7a5fd/.gitignore 0000664 0000000 0000000 00000000164 15150354234 0021215 0 ustar 00root root 0000000 0000000 .coverage
.DS_Store
.eggs
.idea
.pypirc
.pytest_cache
*pyc
*.egg-info
coverage.xml
dist
docs/build
__pycache__
venv
dgarcia360-sphinx-collapse-ea7a5fd/.pre-commit-config.yaml 0000664 0000000 0000000 00000001027 15150354234 0023505 0 ustar 00root root 0000000 0000000 repos:
- repo: https://github.com/pycqa/isort
rev: 5.10.1
hooks:
- id: isort
name: isort (python)
- repo: https://github.com/psf/black
rev: 21.12b0
hooks:
- id: black
exclude: ^venv/
- repo: https://github.com/pycqa/flake8
rev: '4.0.1'
hooks:
- id: flake8
exclude: ^venv/
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.1.0
hooks:
- id: end-of-file-fixer
- id: trailing-whitespace
- id: check-yaml
- id: check-json
dgarcia360-sphinx-collapse-ea7a5fd/.python-version 0000664 0000000 0000000 00000000005 15150354234 0022224 0 ustar 00root root 0000000 0000000 3.12
dgarcia360-sphinx-collapse-ea7a5fd/.readthedocs.yml 0000664 0000000 0000000 00000000743 15150354234 0022316 0 ustar 00root root 0000000 0000000 # Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# Optionally build your docs in additional formats such as PDF and ePub
formats: []
# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: docs/requirements.txt
dgarcia360-sphinx-collapse-ea7a5fd/CHANGELOG.rst 0000664 0000000 0000000 00000001606 15150354234 0021250 0 ustar 00root root 0000000 0000000 =========
Changelog
=========
All notable changes to this project will be documented in this file.
The format is based on `Keep a Changelog `_,
and this project adheres to `Semantic Versioning `_.
0.1.4 - 27 Feb 2026
-------------------
Fixed
=====
* Fixed ``KeyError`` for missing node attributes (e.g. ``backrefs``) in newer
versions of docutils by using ``.pop()`` with a default value of ``None``.
0.1.3 - 22 Feb 2024
-------------------
Added
=====
* The directive can be open by default.
* The extension support paralell builds.
Fixed
=====
* The extension was not compatible with ``sphinx-build latexpdf``.
0.1.2 - 18 May 2022
-------------------
Fixed
=====
* The extension was not compatible with ``sphinx-build latexpdf``.
0.1.1 - 19 Jan 2022
-------------------
Added
=====
* Initial code release
dgarcia360-sphinx-collapse-ea7a5fd/LICENSE.md 0000664 0000000 0000000 00000002067 15150354234 0020635 0 ustar 00root root 0000000 0000000 Copyright (c) 2022-present David Garcia (@dgarcia360).
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
dgarcia360-sphinx-collapse-ea7a5fd/README.rst 0000664 0000000 0000000 00000004077 15150354234 0020723 0 ustar 00root root 0000000 0000000 sphinx-collapse
===============
The ``sphinx-collapse`` extension enhances Sphinx documentation by introducing collapsible sections.
This feature allows documentation authors to create toggles for hiding and revealing detailed content, making documents more manageable and navigable for readers.
Example:
.. 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
-----
Add the collapse directive in your reStructuredText content. Here's a basic example:
.. 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.
Example output:
.. 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 `_ for details on our code of conduct and development process.
License
-------
Copyright (c) 2022 - present David Garcia (`@dgarcia360 `_).
Licensed under the `MIT License `_.
dgarcia360-sphinx-collapse-ea7a5fd/docs/ 0000775 0000000 0000000 00000000000 15150354234 0020154 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/docs/Makefile 0000664 0000000 0000000 00000001176 15150354234 0021621 0 ustar 00root root 0000000 0000000 # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
dgarcia360-sphinx-collapse-ea7a5fd/docs/make.bat 0000664 0000000 0000000 00000001374 15150354234 0021566 0 ustar 00root root 0000000 0000000 @ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
dgarcia360-sphinx-collapse-ea7a5fd/docs/requirements.txt 0000664 0000000 0000000 00000000025 15150354234 0023435 0 ustar 00root root 0000000 0000000 sphinx-collapse[doc]
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/ 0000775 0000000 0000000 00000000000 15150354234 0021454 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/docs/source/_static/ 0000775 0000000 0000000 00000000000 15150354234 0023102 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/docs/source/_static/css/ 0000775 0000000 0000000 00000000000 15150354234 0023672 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/docs/source/_static/css/custom.css 0000664 0000000 0000000 00000000411 15150354234 0025712 0 ustar 00root root 0000000 0000000 .collapse-avatar {
display: flex;
flex-wrap: wrap;
justify-content: space-around;
}
.collapse-avatar li {
list-style: none;
text-align: center;
}
.collapse-avatar li img {
max-width: 150px;
}
.collapse-avatar li a {
display: block;
}
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/_static/example.png 0000664 0000000 0000000 00000021454 15150354234 0025251 0 ustar 00root root 0000000 0000000 PNG
IHDR } sRGB gAMA a pHYs od "IDATx^=# E|Ƶǐp1_ ̪yYd5~ _T!B!'B!OB!rl> !Bi$B!B!OB!r|6~ ?U2?߶=-B!Z t
6|<͍sfʯ??s|B! 擛OD~ڌ
߯~5M˛OՑ'!Ba>24Jm@G5$BT>F-M OB!P_p5y_lSW:lO_ƨ mEζ㧬Hz%B rQkL?|.O>OBq]'rV 1ݚ`Z69e{?%vXB!MvG
h,ܢTD]>4kH> sYLpW6 !Bp
lL}2hf5m>'#&O Ǻ|,8|B!䵸pTΙƳ
۠Y϶ws4# !B^6uڐ4ziku^:|ؕeݪs5߄B!'6 ڴ
Pm3&
j> 4ʒ&.}B
sA^#wK*!Bsͧ~QAQGi j@{ Ls\GdԯZJ Q.OB! |B!OB!rl> !Bi$B!B!OB!rl> !Bi$B!B!OB!rl> !Bi$B!B!OB!rl> !Bi$B!B!OB!rl> !Bi$B!B!OB!rl> !Bi$B!B!ϯď |Kw} 2MȗŷE_~|[}xɝy5̏go<r3<:ϟodFc"Gf^ Y/ϋ^>!' H|I.+Z;kJ>| gy\2yɝxA|R%֟wCctҟ6 #kzy ֛/mŮlxmq o>_Q{ED|PI.cNbUaz |$=|l>_SVp46K6r[n& u0ufsv R NFc-mQNe" Ƨ rby4'3yv^}< zCOuݾ{牣} 䁶[w9 \ɧ~Mjg '>=y;wˁM"sSKOqM*ڢ=~x mX{Cl:qAg)1V |FO>6Ύ|ZO\r5<֯ƞ8|:c[Ogc;';5S
íIǻ_6opވ>kz
'5@hߚ% Gn.ۦ|@\zh:$VP͙:Y_GzPh5 ׅɲs{AU n~8Od,ײַɮY_VY16 s m~/^_ۑQ
Y0ޝZ`{bgΞCρZ;.3_ 5c
2 q\Susu_l0s~5﯁?ھf~9bϺF7gJrt]qN)A+4gdYq].x.;;dq6dp {!rmm5"/3zq؋pH]
,@VO vEZ\oKںﮍlʋʡ`3ܷlok??cl, |rsHfC~Cb t> - SB1r} zDή~bs]mlDn:@<ѾX3y̜͢~t9rл,p
k) o]78&Ld zJH8:k6hɈ[4nVL&t|qO$ ${M~A~qR}o&`]0s(oDfd_w^q t,9k^܃nlg眽W o$6zm٤z!s>Etgܞִ;V0oWwٻܹ\
k) ?|B'# v6u.hC_Yr_亹[[,v!&ozߔ=Mv7uS=8u=>t/ؔ p96ofVڵq?Ȗ}[lPL# QlQt|cw|gѝZcX{3Q q E쩣
6HMA}sf
[ }s 0153toE뎮/]K
=c)d-dv
9ro@5#+5ȋkjK6} Zs:S}ۗS[;]e-z )/
=yrܷlok?9 QleM_ȱ+h@>y߽
cZKTqٹZ, c~⃘(,XnĿ2uƧ(Hg_3>+B'\T6dMGĮg^@sVS ܯy MzOR,,skwv.. 6/:ng #WÕdi,IEt<PէFVǜ|z_1~ns1?_֜]8(^r^<̺x幽m6~M& Wx W_DB$yj-`͛^[зbU Ss3и=eμ8SCwٗRdrTkה9s9~!-:/x|S9YbSm5Ȟ|sٮ Ӝ$*{P< j>5IF#' ~o
:rQ5Hao;;KEZa^Q>V _ :0rK"Ԗ/͏v(>zYm8ulrn J]FO7{7?梨Y" e܌}ϟk)!f3oQ `rU?)'-lM x[^DmE egm]h {L W#rrk5NFTJw~[re;umuFl| E6;'DP/G mVzXH>Iz =` _eUQy
1{i!Pӟi|{P/?S3tO>, pt|^
i|S l< /j_ &SOƓ|
l> `̯!Fy32B!OB!rl> !Bi$B!B!OB!rl> !Bi|Ӏ{G7"
{O@ Uw;G?AM3}b 3D`y$mdulbul BٟlO ˅ֆ/Z0ű5?0;dԖgyhCklfг^8?ϒ{\sL Z3u)Yl`r擐ǃs6
ϯO`%W3@/U h=IZ8K
Tӆ:]Nm>:T/am\?i#< $=Clm6}3ʈ _Ƈ:5=M+6Fl9s^Ovvٷa`;&?T9K 8+ٮ5>Zd{˽̞~ր5EW˺z<7]TՆx^û93
=pEbLs)C䣹̟ yuٕ{{88G<1Gju
1 ^l[.%5ulel~xW&}1^FLGilgI~.2n? W0]
ݺ8' ,
S:gI ZmsO>9܅6Z h]{
&d;]|kuȲlw zH<8<ۭWNmc@ 9o^,,YKWq_q&t97g
t[m,/2, Ӊ .E69Y*#iaW$ 3e[+{k:ƌ
ɹvf0^:zqw'r/ 8gkP BjdA;ec]ߘʡA~ ^|{!*e.q3.NKؼ{fE WT#`!HuAk?'|>sk
zF=k
/Y_f}y#Y
/NDEn܌ 'fea:1Qi45Ug/sƩ-ř.UvAugX7g$AJHNU]\R!bE=<$1ȾOİumBq*s3#~z #m./KϺۙ y>5czxĹsLy{^3Lyrd#M u> XF};!9w [Y.+ =8Q_j2|]5^< 5{s q%n2qҳ_o~\lԻko8|n F1tf8qM: -a@}QSu&q낾̟e6Aod
[rD^痢f{aoƭ}cP 1vޏ!_rލܭp|sac;
(g9Eu=3AF/Ѹ^b72c9.~3'~wq8cٿŴ/.VVʅ0W}29\֫rsE[1϶7 ӽӺ-FYzv5nW1k#\ {W{^.}hC7 Oz,?$ R: .ǧC E#g'!$ ƠK'!䆔{OX OBH}uLiJuC|r՝:~f|B g ԓ~ h!a ?=l> !Bi$B!B!OB!rl> !Bi$B!B!WhpvWyٟo#C~A4Bn<"/|͖67v!}gwor2cGjNwk2!ͧ~RV{\`,)G}N/4|Srލi
1W5^-\G}xYJȗqR5oI-`yo|a9
Gg<>l>
Or=7h>[H kcJ Zu45[[G8G/u2D~ƪխ s wj^Yt)~mbhe e=rCG>fukL.0Xrs6hlX{@n7bvw]3ȭ^-qwAWu}XJ\*g8wfS]gb~^d*}Ǒ#uWQͣƑʰ&6bnq_Be"RȬ6YJ+D k>%q7IڊPcT|-$?z9o'k>Y~UvYj/O5s@/0tqΝ7H[ciYc
s K9 R.:|>n۔l {<(K9UsrU \}ms5g Ѯi;-@m}glwn^șQͥ N OMv4BŞTbIΥQ5AW0ZA^Z 0sy`=F>vw~W{@$.S`(WW-q~lW\s#~žzgW` r_ =6\NCf! 5$"ۍ GlA}y?[uVcLM\N}gZ8j^K甶
d'(FJԹXMtL+M^>_+^/2M ]._)=˨}tϕ9ӑU': {{+@Q,A>u=(fܚuڋ|#YyultB4]/~eFguιLM|ZkNJ~i4;A뙨vlBf0K"oIZ
%uKpZdBɭ\xi4CL@ݙ^k^&ʼB@KstŜһH9'{!i:*;́G>2a hII#'5ᒿk+͕Z2RAs֕puo9']Bs e={s O ;Xgع ^1~u?p-˭,fTQC%V^ÙW'!ֹBsXm|k盜ٙNb!9eXh MN}W왹+F>[d:95SKou\$&'!O{43Ha <=D$OBS擐 |'!)aIl>Ƀd;pM?{#|g 96B!4|B!`I!BN'!B9
6B!4|B!`I!BN'!B9
6B!4|B!`I!BN'!B9
6B!4|B!`I!BN z"̸ IENDB` dgarcia360-sphinx-collapse-ea7a5fd/docs/source/conf.py 0000664 0000000 0000000 00000003255 15150354234 0022760 0 ustar 00root root 0000000 0000000 # Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
from datetime import date
# -- Project information -----------------------------------------------------
docstitle = "sphinx-collapse"
project = "sphinx-collapse"
copyright = str(date.today().year) + ", David Garcia. All rights reserved."
author = "David Garcia"
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["sphinx_collapse"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["build/*"]
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "alabaster"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named 'default.css' will overwrite the builtin 'default.css'.
html_static_path = ["_static"]
# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
"css/custom.css",
]
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/contribute.rst 0000664 0000000 0000000 00000001213 15150354234 0024361 0 ustar 00root root 0000000 0000000 Contribute
==========
Thanks for considering contributing to this extension!
* See the `issue tracker `_ for a list of features we would like to add in the future.
* Feel free to propose new features or report bugs, describing how you want the extension to behave.
* Let us know in the same issue if you want to send a pull-request ❤️
This project adheres to the `Contributor Covenant Code of Conduct `_.
By participating, you are expected to uphold this code. Please report unacceptable behavior to `@dgarcia360 `_.
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/index.rst 0000664 0000000 0000000 00000002521 15150354234 0023315 0 ustar 00root root 0000000 0000000 Overview
========
The ``sphinx-collapse`` extension enhances Sphinx documentation by introducing collapsible sections.
This feature allows documentation authors to create toggles for hiding and revealing detailed content, making documents more manageable and navigable for readers.
Example usage:
.. 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.
Features
--------
**Hide content**
Use a Sphinx directive specifically designed to toggle content visibility, enhancing document readability.
**Lightweight**
This extension operates without JavaScript and does not depend on external CSS frameworks like Bootstrap, Tailwind CSS, or Foundation.
**Customizable**
Offers flexibility in styling collapsible sections through various options and CSS customizations to match your documentation's aesthetic.
Get started
-----------
.. toctree::
:maxdepth: 1
installation
usage
reference
who-is-using-it
contribute
License
-------
Copyright (c) 2022 - present David Garcia (`@dgarcia360 `_).
Licensed under the `MIT License `_.
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/installation.rst 0000664 0000000 0000000 00000000531 15150354234 0024706 0 ustar 00root root 0000000 0000000 Installation
============
.. important:: ``sphinx-collapse`` is compatible with Sphinx 3.0+ using Python 3.7+.
#. 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']
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/reference.rst 0000664 0000000 0000000 00000001575 15150354234 0024154 0 ustar 00root root 0000000 0000000 =========
Reference
=========
The `collapse` directive allows you to create collapsible content blocks in your documentation with an optional heading.
Syntax
------
.. code-block:: rst
.. collapse::
:class_name:
:open:
:icon:
Options
-------
.. rst:directive:: .. collapse::
.. rst:directive:option:: class_name
:type: string
The HTML class name that wraps the ``collapse`` element.
By default, this is ``sphinx_collapse``.
.. rst:directive:option:: open
:type: string
If set, the collapsible block is expanded by default.
.. rst:directive:option:: icon
:type: string
The HTML class name that defines the ``collapse`` icon.
By default, this is set to ``sphinx_collapse_icon``.
To specify multiple classes, separate the class names with a space, e.g. ``:icon: fa fa-caret-down``.
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/usage.rst 0000664 0000000 0000000 00000001234 15150354234 0023312 0 ustar 00root root 0000000 0000000 Usage
=====
Add the collapse directive in your reStructuredText content. Here's a basic example:
.. 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.
Example output:
.. 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.
dgarcia360-sphinx-collapse-ea7a5fd/docs/source/who-is-using-it.rst 0000664 0000000 0000000 00000001651 15150354234 0025154 0 ustar 00root root 0000000 0000000 Who is using it?
================
Alation Documentation:
https://docs.alationdata.com/en/latest/admins/Troubleshooting/LogsOverview.html#django
BattMo:
https://battmoteam.github.io/BattMo/intermediate.html#file-links-and-insertions-with-parsebattmojson
CoLRev:
https://colrev.readthedocs.io/en/latest/manual/operations.html
IDF Component Manager:
https://docs.espressif.com/projects/idf-component-manager/en/latest/index.html
Intel Labs:
https://intellabs.github.io/ScalableVectorSearch/start.html#generating-test-data
PlasmaPy:
https://docs.plasmapy.org/en/stable/contributing/workflow.html#create-a-new-branch
pymadcap:
https://pymadcad.readthedocs.io/en/latest/reference/mesh/web.html
ScyllaDB:
https://sphinx-theme.scylladb.com/stable/examples/collapse.html
Trossen Robotics:
https://docs.trossenrobotics.com/interbotix_xslocobots_docs/ros_interface/ros1/software_setup.html
dgarcia360-sphinx-collapse-ea7a5fd/pyproject.toml 0000664 0000000 0000000 00000000662 15150354234 0022144 0 ustar 00root root 0000000 0000000 [build-system]
requires = ["flit_core >=2,<4"]
build-backend = "flit_core.buildapi"
[tool.flit.metadata]
module = "sphinx_collapse"
author = "David Garcia"
author-email = "hi@davidgarcia.dev"
home-page = "https://github.com/dgarcia360/sphinx-collapse"
description-file = "README.rst"
requires-python = ">=3.7"
requires = ["sphinx >= 3"]
[tool.flit.metadata.requires-extra]
test = [
"pre-commit",
"pytest",
]
doc = ["alabaster"]
dgarcia360-sphinx-collapse-ea7a5fd/src/ 0000775 0000000 0000000 00000000000 15150354234 0020013 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/src/sphinx_collapse/ 0000775 0000000 0000000 00000000000 15150354234 0023206 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/src/sphinx_collapse/__init__.py 0000664 0000000 0000000 00000010617 15150354234 0025324 0 ustar 00root root 0000000 0000000 """
Collapse extension for Sphinx.
(c) 2022 - present David Garcia (@dgarcia360)
# This code is licensed under MIT license (see LICENSE.md for details)
"""
from pathlib import Path
from uuid import uuid4
from docutils import nodes
from docutils.parsers.rst import directives
from sphinx.application import Sphinx
from sphinx.util.docutils import SphinxDirective
__version__ = "0.1.4"
class _HTMLElement(nodes.Element, nodes.General):
"""
Generic HTML element
Adapted from https://github.com/pradyunsg/sphinx-inline-tabs
"""
@staticmethod
def visit(translator, node):
attributes = node.attributes.copy()
# Not necessary
attributes.pop("ids", None)
attributes.pop("classes", None)
attributes.pop("names", None)
attributes.pop("dupnames", None)
attributes.pop("backrefs", None)
text = translator.starttag(node, node.tagname, **attributes)
translator.body.append(text.strip())
@staticmethod
def depart(translator, node):
if node.endtag:
translator.body.append(f"")
@staticmethod
def default(translator, node):
pass
class _HTMLLabel(_HTMLElement):
"""
Label HTML element
"""
tagname = "label"
endtag = True
class _HTMLIcon(_HTMLElement):
"""
Icon HTML element
"""
tagname = "i"
endtag = True
class _HTMLInput(_HTMLElement):
"""
Input HTML element
"""
tagname = "input"
endtag = False
class CollapseDirective(SphinxDirective):
"""
Collapse directive
"""
has_content = True
required_arguments = 1
optional_arguments = 0
final_argument_whitespace = True
option_spec = {
"class_name": directives.unchanged,
"icon": directives.unchanged,
"open": directives.flag,
}
def run(self):
self.assert_has_content()
class_name = self.options.get("class_name", "sphinx_collapse")
collapse_id = str(uuid4())
open_by_default = "open" in self.options
# container
container_class_name = class_name
container = nodes.container(
"",
id=collapse_id,
is_div=True,
classes=[container_class_name],
)
# input
input_class_name = class_name + "__input"
input_attributes = {
"type": "checkbox",
"ids": [collapse_id],
"name": collapse_id,
"classes": [input_class_name],
}
if open_by_default:
input_attributes["checked"] = "checked"
custom_input = _HTMLInput(**input_attributes)
# icon
icon_class_name = self.options.get("icon", class_name + "__icon")
icon = _HTMLIcon(classes=[icon_class_name])
# label
label_class_name = class_name + "__label"
label = _HTMLLabel(
**{"for": collapse_id},
classes=[label_class_name],
)
text = self.arguments[0].strip()
label += icon
label += nodes.Text(text, text)
# content
content_class_name = class_name + "__content"
content = nodes.container(
"",
is_div=True,
classes=[content_class_name],
)
self.state.nested_parse(self.content, self.content_offset, content)
container += custom_input
container += label
container += content
return [container]
def setup(app: Sphinx) -> dict:
"""
Loads collapse directive
"""
# Add CSS
static_dir = str(Path(__file__).parent.joinpath("_static").absolute())
app.connect(
"builder-inited", (lambda app: app.config.html_static_path.append(static_dir))
)
app.add_css_file("sphinx_collapse.css")
# Add custom nodes
app.add_node(
_HTMLIcon,
html=(_HTMLIcon.visit, _HTMLIcon.depart),
latex=(_HTMLLabel.default, _HTMLLabel.default),
)
app.add_node(
_HTMLLabel,
html=(_HTMLLabel.visit, _HTMLLabel.depart),
latex=(_HTMLLabel.default, _HTMLLabel.default),
)
app.add_node(
_HTMLInput,
html=(_HTMLInput.visit, _HTMLInput.depart),
latex=(_HTMLLabel.default, _HTMLLabel.default),
)
# Add directive
app.add_directive("collapse", CollapseDirective)
return {
"version": "0.1",
"parallel_read_safe": True,
"parallel_write_safe": True,
} dgarcia360-sphinx-collapse-ea7a5fd/src/sphinx_collapse/_static/ 0000775 0000000 0000000 00000000000 15150354234 0024634 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/src/sphinx_collapse/_static/sphinx_collapse.css 0000664 0000000 0000000 00000000773 15150354234 0030550 0 ustar 00root root 0000000 0000000 .sphinx_collapse {
margin: 5px 0;
}
.sphinx_collapse__label {
align-items: center;
cursor: pointer;
display: flex;
}
.sphinx_collapse__icon {
border-left: 5px solid transparent;
border-right: 5px solid transparent;
border-top: 5px solid #000;
margin-right: 5px;
width: 0;
height: 0;
}
.sphinx_collapse__input {
display: none;
}
.sphinx_collapse__content {
margin-top: 5px;
display: none;
}
.sphinx_collapse__input:checked ~ .sphinx_collapse__content {
display: block;
}
dgarcia360-sphinx-collapse-ea7a5fd/tests/ 0000775 0000000 0000000 00000000000 15150354234 0020366 5 ustar 00root root 0000000 0000000 dgarcia360-sphinx-collapse-ea7a5fd/tests/__init__.py 0000664 0000000 0000000 00000000046 15150354234 0022477 0 ustar 00root root 0000000 0000000 """
Tests for collapse extension.
"""
dgarcia360-sphinx-collapse-ea7a5fd/tests/test_collapse.py 0000664 0000000 0000000 00000005230 15150354234 0023601 0 ustar 00root root 0000000 0000000 """
Tests for collapse extension.
(c) 2022 - present David Garcia (@dgarcia360)
# This code is licensed under MIT license (see LICENSE.md for details)
"""
import subprocess
import sys
from pathlib import Path
from textwrap import dedent
def test_substitution_prompt(tmp_path: Path) -> None:
"""
The ``collapse`` directive runs with no errors.
"""
source_directory = tmp_path / "source"
source_directory.mkdir()
source_file = source_directory / "index.rst"
conf_py = source_directory / "conf.py"
conf_py.touch()
source_file.touch()
conf_py_content = dedent(
"""\
extensions = ['sphinx_collapse']
""",
)
conf_py.write_text(conf_py_content)
source_file_content = dedent(
"""\
.. collapse:: Heading
Lorem ipsum
""",
)
source_file.write_text(source_file_content)
destination_directory = tmp_path / "destination"
args = [
sys.executable,
"-m",
"sphinx",
"-b",
"html",
"-W",
# Directory containing source and configuration files.
str(source_directory),
# Directory containing build files.
str(destination_directory),
# Source file to process.
str(source_file),
]
subprocess.check_output(args=args)
expected = "Lorem ipsum"
content_html = Path(str(destination_directory)) / "index.html"
assert expected in content_html.read_text()
def test_collapse_open_by_default(tmp_path: Path) -> None:
"""
The ``collapse`` directive correctly handles the 'open' attribute to make the collapse open by default.
"""
source_directory = tmp_path / "source"
source_directory.mkdir()
source_file = source_directory / "index.rst"
conf_py = source_directory / "conf.py"
conf_py.touch()
source_file.touch()
conf_py_content = dedent(
"""\
extensions = ['sphinx_collapse']
""",
)
conf_py.write_text(conf_py_content)
# Assuming 'open' is the option to make the collapse open by default
source_file_content = dedent(
"""\
.. collapse:: Heading
:open:
Lorem ipsum
""",
)
source_file.write_text(source_file_content)
destination_directory = tmp_path / "destination"
args = [
sys.executable,
"-m",
"sphinx",
"-b",
"html",
"-W",
str(source_directory),
str(destination_directory),
str(source_file),
]
subprocess.check_output(args=args)
content_html = Path(str(destination_directory)) / "index.html"
content = content_html.read_text()
assert 'checked' in content