Skip to content

Commit 67fa7b7

Browse files
lepturelepture
committed
docs: using sphinx-iconify extension
1 parent 1966609 commit 67fa7b7

File tree

5 files changed

+61
-93
lines changed

5 files changed

+61
-93
lines changed

‎docs/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,11 @@
2727
"sphinx_design",
2828
"sphinx_sitemap",
2929
"sphinx_contributors",
30+
"sphinx_iconify",
3031
]
3132

33+
iconify_script_url = ""
34+
3235
extlinks = {
3336
"user": ("https://github.com/%s", "@%s"),
3437
"pull": ("https://github.com/authlib/joserfc/pull/%s", "pull request #%s"),

‎docs/install.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,33 @@ cryptography, you can follow the documentation
1616

1717
.. _cryptography: https://cryptography.io/
1818

19-
pip install
20-
-----------
19+
Package install
20+
---------------
2121

22-
``joserfc`` is conveniently available as a Python package on PyPI and can be easily
23-
installed using pip.
22+
``joserfc`` is conveniently available as a Python package on PyPI_ and conda-forge_.
23+
It can be easily installed via:
2424

2525
.. tab-set::
26+
:class: outline
2627

27-
.. tab-item:: pip
28+
.. tab-item:: :iconify:`devicon:pypi` pip
2829

2930
.. code-block:: shell
3031
3132
pip install joserfc
3233
33-
.. tab-item:: uv
34+
.. tab-item:: :iconify:`material-icon-theme:uv` uv
3435

3536
.. code-block:: shell
3637
3738
uv add joserfc
3839
40+
.. tab-item:: :iconify:`devicon:anaconda` conda
41+
42+
.. code-block:: shell
43+
44+
conda install conda-forge::joserfc
45+
3946
.. important::
4047

4148
To use :ref:`chacha20` algorithms, developers have to install the ``PyCryptodome`` module.
@@ -44,15 +51,7 @@ installed using pip.
4451
4552
pip install joserfc pycryptodome
4653
47-
conda install
48-
-------------
49-
50-
``joserfc`` is also available from conda-forge_:
51-
52-
.. code-block:: shell
53-
54-
conda install conda-forge::joserfc
55-
54+
.. _PyPI: https://pypi.org/project/joserfc/
5655
.. _conda-forge: https://anaconda.org/conda-forge/joserfc
5756

5857
Dependency management

‎pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ docs = [
6868
"sphinx-design",
6969
"sphinx-intl",
7070
"sphinx-sitemap",
71+
"sphinx-iconify",
7172
]
7273

7374
[tool.ruff]

‎requirements-dev.lock

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,28 @@
44
cffi==1.17.1 ; platform_python_implementation != 'PyPy'
55
cfgv==3.4.0
66
colorama==0.4.6 ; sys_platform == 'win32'
7-
coverage==7.6.1 ; python_full_version < '3.9'
8-
coverage==7.9.1 ; python_full_version >= '3.9'
7+
coverage==7.9.2
98
cryptography==45.0.5
109
distlib==0.3.9
1110
exceptiongroup==1.3.0 ; python_full_version < '3.11'
12-
filelock==3.16.1 ; python_full_version < '3.9'
13-
filelock==3.18.0 ; python_full_version >= '3.9'
14-
identify==2.6.1 ; python_full_version < '3.9'
15-
identify==2.6.12 ; python_full_version >= '3.9'
11+
filelock==3.18.0
12+
identify==2.6.12
1613
iniconfig==2.1.0
17-
mypy==1.14.1 ; python_full_version < '3.9'
18-
mypy==1.16.1 ; python_full_version >= '3.9'
14+
mypy==1.17.0
1915
mypy-extensions==1.1.0
2016
nodeenv==1.9.1
2117
packaging==25.0
22-
pathspec==0.12.1 ; python_full_version >= '3.9'
23-
platformdirs==4.3.6 ; python_full_version < '3.9'
24-
platformdirs==4.3.8 ; python_full_version >= '3.9'
25-
pluggy==1.5.0 ; python_full_version < '3.9'
26-
pluggy==1.6.0 ; python_full_version >= '3.9'
27-
pre-commit==3.5.0 ; python_full_version < '3.9'
28-
pre-commit==4.2.0 ; python_full_version >= '3.9'
18+
pathspec==0.12.1
19+
platformdirs==4.3.8
20+
pluggy==1.6.0
21+
pre-commit==4.2.0
2922
pycparser==2.22 ; platform_python_implementation != 'PyPy'
3023
pycryptodome==3.23.0
31-
pygments==2.19.2 ; python_full_version >= '3.9'
32-
pytest==8.3.5 ; python_full_version < '3.9'
33-
pytest==8.4.1 ; python_full_version >= '3.9'
34-
pytest-cov==5.0.0 ; python_full_version < '3.9'
35-
pytest-cov==6.2.1 ; python_full_version >= '3.9'
24+
pygments==2.19.2
25+
pytest==8.4.1
26+
pytest-cov==6.2.1
3627
pyyaml==6.0.2
37-
ruff==0.12.1
28+
ruff==0.12.3
3829
tomli==2.2.1 ; python_full_version <= '3.11'
39-
typing-extensions==4.13.2 ; python_full_version < '3.9'
40-
typing-extensions==4.14.0 ; python_full_version >= '3.9'
30+
typing-extensions==4.14.1
4131
virtualenv==20.31.2

‎requirements-docs.lock

Lines changed: 30 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,67 @@
11
# This file was autogenerated by uv via the following command:
22
# uv export --no-hashes --group docs -o requirements-docs.lock
33
-e .
4-
alabaster==0.7.13 ; python_full_version < '3.9'
5-
alabaster==0.7.16 ; python_full_version == '3.9.*'
4+
alabaster==0.7.16 ; python_full_version < '3.10'
65
alabaster==1.0.0 ; python_full_version >= '3.10'
76
babel==2.17.0
8-
certifi==2025.6.15
7+
certifi==2025.7.14
98
cffi==1.17.1 ; platform_python_implementation != 'PyPy'
109
cfgv==3.4.0
1110
charset-normalizer==3.4.2
1211
click==8.1.8 ; python_full_version < '3.10'
1312
click==8.2.1 ; python_full_version >= '3.10'
1413
colorama==0.4.6 ; sys_platform == 'win32'
15-
coverage==7.6.1 ; python_full_version < '3.9'
16-
coverage==7.9.1 ; python_full_version >= '3.9'
14+
coverage==7.9.2
1715
cryptography==45.0.5
1816
distlib==0.3.9
19-
docutils==0.20.1 ; python_full_version < '3.9'
20-
docutils==0.21.2 ; python_full_version >= '3.9'
17+
docutils==0.21.2
2118
exceptiongroup==1.3.0 ; python_full_version < '3.11'
22-
filelock==3.16.1 ; python_full_version < '3.9'
23-
filelock==3.18.0 ; python_full_version >= '3.9'
24-
identify==2.6.1 ; python_full_version < '3.9'
25-
identify==2.6.12 ; python_full_version >= '3.9'
19+
filelock==3.18.0
20+
identify==2.6.12
2621
idna==3.10
2722
imagesize==1.4.1
28-
importlib-metadata==8.5.0 ; python_full_version < '3.9'
29-
importlib-metadata==8.7.0 ; python_full_version == '3.9.*'
23+
importlib-metadata==8.7.0 ; python_full_version < '3.10'
3024
iniconfig==2.1.0
3125
jinja2==3.1.6
32-
markupsafe==2.1.5 ; python_full_version < '3.9'
33-
markupsafe==3.0.2 ; python_full_version >= '3.9'
34-
mypy==1.14.1 ; python_full_version < '3.9'
35-
mypy==1.16.1 ; python_full_version >= '3.9'
26+
markupsafe==3.0.2
27+
mypy==1.17.0
3628
mypy-extensions==1.1.0
3729
nodeenv==1.9.1
3830
packaging==25.0
39-
pathspec==0.12.1 ; python_full_version >= '3.9'
40-
platformdirs==4.3.6 ; python_full_version < '3.9'
41-
platformdirs==4.3.8 ; python_full_version >= '3.9'
42-
pluggy==1.5.0 ; python_full_version < '3.9'
43-
pluggy==1.6.0 ; python_full_version >= '3.9'
44-
pre-commit==3.5.0 ; python_full_version < '3.9'
45-
pre-commit==4.2.0 ; python_full_version >= '3.9'
31+
pathspec==0.12.1
32+
platformdirs==4.3.8
33+
pluggy==1.6.0
34+
pre-commit==4.2.0
4635
pycparser==2.22 ; platform_python_implementation != 'PyPy'
4736
pycryptodome==3.23.0
4837
pygments==2.19.2
49-
pytest==8.3.5 ; python_full_version < '3.9'
50-
pytest==8.4.1 ; python_full_version >= '3.9'
51-
pytest-cov==5.0.0 ; python_full_version < '3.9'
52-
pytest-cov==6.2.1 ; python_full_version >= '3.9'
53-
pytz==2025.2 ; python_full_version < '3.9'
38+
pytest==8.4.1
39+
pytest-cov==6.2.1
5440
pyyaml==6.0.2
5541
requests==2.32.4
5642
roman-numerals-py==3.1.0 ; python_full_version >= '3.11'
57-
ruff==0.12.1
58-
setuptools==75.3.2 ; python_full_version < '3.9'
59-
setuptools==80.9.0 ; python_full_version >= '3.9'
60-
shibuya==2025.5.30
43+
ruff==0.12.3
44+
setuptools==80.9.0
45+
shibuya==2025.7.14
6146
snowballstemmer==3.0.1
62-
sphinx==7.1.2 ; python_full_version < '3.9'
63-
sphinx==7.4.7 ; python_full_version == '3.9.*'
47+
sphinx==7.4.7 ; python_full_version < '3.10'
6448
sphinx==8.1.3 ; python_full_version == '3.10.*'
6549
sphinx==8.2.3 ; python_full_version >= '3.11'
6650
sphinx-contributors==0.2.7
6751
sphinx-copybutton==0.5.2
68-
sphinx-design==0.5.0 ; python_full_version < '3.9'
69-
sphinx-design==0.6.1 ; python_full_version >= '3.9'
70-
sphinx-intl==2.2.0 ; python_full_version < '3.9'
71-
sphinx-intl==2.3.1 ; python_full_version >= '3.9'
52+
sphinx-design==0.6.1
53+
sphinx-iconify==0.2.0
54+
sphinx-intl==2.3.1
7255
sphinx-last-updated-by-git==0.3.8
7356
sphinx-sitemap==2.7.2
74-
sphinxcontrib-applehelp==1.0.4 ; python_full_version < '3.9'
75-
sphinxcontrib-applehelp==2.0.0 ; python_full_version >= '3.9'
76-
sphinxcontrib-devhelp==1.0.2 ; python_full_version < '3.9'
77-
sphinxcontrib-devhelp==2.0.0 ; python_full_version >= '3.9'
78-
sphinxcontrib-htmlhelp==2.0.1 ; python_full_version < '3.9'
79-
sphinxcontrib-htmlhelp==2.1.0 ; python_full_version >= '3.9'
57+
sphinxcontrib-applehelp==2.0.0
58+
sphinxcontrib-devhelp==2.0.0
59+
sphinxcontrib-htmlhelp==2.1.0
8060
sphinxcontrib-jsmath==1.0.1
81-
sphinxcontrib-qthelp==1.0.3 ; python_full_version < '3.9'
82-
sphinxcontrib-qthelp==2.0.0 ; python_full_version >= '3.9'
83-
sphinxcontrib-serializinghtml==1.1.5 ; python_full_version < '3.9'
84-
sphinxcontrib-serializinghtml==2.0.0 ; python_full_version >= '3.9'
61+
sphinxcontrib-qthelp==2.0.0
62+
sphinxcontrib-serializinghtml==2.0.0
8563
tomli==2.2.1 ; python_full_version <= '3.11'
86-
typing-extensions==4.13.2 ; python_full_version < '3.9'
87-
typing-extensions==4.14.0 ; python_full_version >= '3.9'
88-
urllib3==2.2.3 ; python_full_version < '3.9'
89-
urllib3==2.5.0 ; python_full_version >= '3.9'
64+
typing-extensions==4.14.1
65+
urllib3==2.5.0
9066
virtualenv==20.31.2
91-
zipp==3.20.2 ; python_full_version < '3.9'
92-
zipp==3.23.0 ; python_full_version == '3.9.*'
67+
zipp==3.23.0 ; python_full_version < '3.10'

0 commit comments

Comments
 (0)