Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Commit c853dd6

Browse files
authored
Dependencies: add minimum docutils version (#281)
Dependencies: add sphinxcontrib-bibtex min version Otherwise the lack of a pin on docutils causes bad html rendering. Docutils versions lower than 0.20 cause rendering problems in the usage page with the bibliography, see #280. upgrade docs/requirements.txt with pip-compile after the pyproject.toml change.
1 parent e4707d2 commit c853dd6

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

docs/requirements.txt

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44
#
55
# pip-compile --extra=doc --output-file=docs/requirements.txt pyproject.toml
66
#
7-
alabaster==0.7.13
7+
alabaster==0.7.16
88
# via sphinx
99
anyascii==0.3.2
1010
# via sphinx-autoapi
11-
astroid==3.0.2
11+
astroid==3.0.3
1212
# via sphinx-autoapi
1313
babel==2.14.0
1414
# via sphinx
15-
certifi==2023.11.17
15+
certifi==2024.2.2
1616
# via requests
1717
charset-normalizer==3.3.2
1818
# via requests
1919
colorama==0.4.6
2020
# via sphinx-autobuild
21-
docutils==0.18.1
21+
docutils==0.20.1
2222
# via
2323
# pybtex-docutils
2424
# sphinx
@@ -30,15 +30,15 @@ idna==3.6
3030
# via requests
3131
imagesize==1.4.1
3232
# via sphinx
33-
jinja2==3.1.2
33+
jinja2==3.1.3
3434
# via
3535
# sphinx
3636
# sphinx-autoapi
3737
latexcodec==2.0.1
3838
# via pybtex
3939
livereload==2.6.3
4040
# via sphinx-autobuild
41-
markupsafe==2.1.3
41+
markupsafe==2.1.5
4242
# via jinja2
4343
packaging==23.2
4444
# via sphinx
@@ -76,51 +76,46 @@ sphinx==7.2.6
7676
# sphinx-rtd-theme
7777
# sphinx-tabs
7878
# sphinx-version-warning
79-
# sphinxcontrib-applehelp
8079
# sphinxcontrib-bibtex
81-
# sphinxcontrib-devhelp
82-
# sphinxcontrib-htmlhelp
8380
# sphinxcontrib-jquery
84-
# sphinxcontrib-qthelp
85-
# sphinxcontrib-serializinghtml
8681
# sphinxemoji
8782
sphinx-autoapi==3.0.0
8883
# via sphinx-hoverxref (pyproject.toml)
89-
sphinx-autobuild==2021.3.14
84+
sphinx-autobuild==2024.2.4
9085
# via sphinx-hoverxref (pyproject.toml)
9186
sphinx-notfound-page==1.0.0
9287
# via sphinx-hoverxref (pyproject.toml)
9388
sphinx-prompt==1.8.0
9489
# via sphinx-hoverxref (pyproject.toml)
9590
sphinx-rtd-theme==2.0.0
9691
# via sphinx-hoverxref (pyproject.toml)
97-
sphinx-tabs==3.4.4
92+
sphinx-tabs==3.4.5
9893
# via sphinx-hoverxref (pyproject.toml)
9994
sphinx-version-warning==1.1.2
10095
# via sphinx-hoverxref (pyproject.toml)
101-
sphinxcontrib-applehelp==1.0.7
96+
sphinxcontrib-applehelp==1.0.8
10297
# via sphinx
103-
sphinxcontrib-bibtex==2.5.0
98+
sphinxcontrib-bibtex==2.6.2
10499
# via sphinx-hoverxref (pyproject.toml)
105-
sphinxcontrib-devhelp==1.0.5
100+
sphinxcontrib-devhelp==1.0.6
106101
# via sphinx
107-
sphinxcontrib-htmlhelp==2.0.4
102+
sphinxcontrib-htmlhelp==2.0.5
108103
# via sphinx
109104
sphinxcontrib-jquery==4.1
110105
# via
111106
# sphinx-hoverxref (pyproject.toml)
112107
# sphinx-rtd-theme
113108
sphinxcontrib-jsmath==1.0.1
114109
# via sphinx
115-
sphinxcontrib-qthelp==1.0.6
110+
sphinxcontrib-qthelp==1.0.7
116111
# via sphinx
117-
sphinxcontrib-serializinghtml==1.1.9
112+
sphinxcontrib-serializinghtml==1.1.10
118113
# via sphinx
119-
sphinxemoji==0.2.0
114+
sphinxemoji==0.3.1
120115
# via sphinx-hoverxref (pyproject.toml)
121116
tornado==6.4
122117
# via livereload
123118
typing-extensions==4.9.0
124119
# via astroid
125-
urllib3==2.1.0
120+
urllib3==2.2.1
126121
# via requests

pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,10 @@ doc = [
4949
"sphinx-version-warning",
5050
"sphinx-notfound-page",
5151
"sphinx-autobuild",
52-
"sphinxcontrib-bibtex",
52+
# versions older than this don't pin
53+
# docutils which is necessary for
54+
# bibtex html rendering to work properly
55+
"sphinxcontrib-bibtex>=2.6.0",
5356
"sphinxemoji",
5457
]
5558

0 commit comments

Comments
 (0)