Skip to content

Commit c9dcab7

Browse files
authored
Merge pull request #1001 from gchq/fix/sphinx-8.2
Fix compatibility with sphinx 8.2.x
2 parents c7fe19d + 03116a1 commit c9dcab7

File tree

4 files changed

+230
-159
lines changed

4 files changed

+230
-159
lines changed

documentation/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
# pylint: disable=invalid-name
106106
bibtex_default_style = STYLE_NAME
107107
bibtex_references_path = SOURCE_FOLDER_PATH / "references.bib"
108-
bibtex_bibfiles = [str(bibtex_references_path)]
108+
bibtex_bibfiles = [bibtex_references_path.relative_to(SOURCE_FOLDER_PATH).as_posix()]
109109
# pylint: enable=invalid-name
110110

111111

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ test = [
7272
# Compile documentation
7373
doc = [
7474
"furo>=2024",
75-
"sphinx>=7, !=8.2.*",
75+
"sphinx>=7",
7676
"sphinx-autodoc-typehints>=2",
7777
"sphinx-toolbox>=3",
7878
"sphinxcontrib-bibtex>=2",

requirements-doc.txt

+8-5
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jaxlib==0.4.30 ; python_full_version < '3.10'
4040
jaxlib==0.4.38 ; python_full_version >= '3.10'
4141
jaxopt==0.8.3
4242
jaxtyping==0.2.36 ; python_full_version < '3.10'
43-
jaxtyping==0.2.38 ; python_full_version >= '3.10'
43+
jaxtyping==0.3.0 ; python_full_version >= '3.10'
4444
jinja2==3.1.6
4545
joblib==1.4.2
4646
jsonschema==4.23.0
@@ -61,7 +61,7 @@ optax==0.2.4
6161
orbax-checkpoint==0.6.4 ; python_full_version < '3.10'
6262
orbax-checkpoint==0.11.5 ; python_full_version >= '3.10'
6363
packaging==24.2
64-
platformdirs==4.3.6
64+
platformdirs==4.3.7
6565
protobuf==6.30.1
6666
pybtex==0.24.0
6767
pybtex-docutils==1.0.3
@@ -70,21 +70,24 @@ pyyaml==6.0.2
7070
referencing==0.36.2
7171
requests==2.32.3
7272
rich==13.9.4
73+
roman-numerals-py==3.1.0 ; python_full_version >= '3.11'
7374
rpds-py==0.23.1
7475
ruamel-yaml==0.18.10
7576
ruamel-yaml-clib==0.2.12 ; python_full_version < '3.13' and platform_python_implementation == 'CPython'
7677
scikit-learn==1.6.1
7778
scipy==1.13.1 ; python_full_version < '3.10'
7879
scipy==1.15.2 ; python_full_version >= '3.10'
79-
setuptools==76.0.0 ; python_full_version >= '3.12'
80+
setuptools==77.0.1 ; python_full_version >= '3.12'
8081
simplejson==3.20.1 ; python_full_version >= '3.10'
8182
six==1.17.0
8283
snowballstemmer==2.2.0
8384
soupsieve==2.6
8485
sphinx==7.4.7 ; python_full_version < '3.10'
85-
sphinx==8.1.3 ; python_full_version >= '3.10'
86+
sphinx==8.1.3 ; python_full_version == '3.10.*'
87+
sphinx==8.2.3 ; python_full_version >= '3.11'
8688
sphinx-autodoc-typehints==2.3.0 ; python_full_version < '3.10'
87-
sphinx-autodoc-typehints==3.0.1 ; python_full_version >= '3.10'
89+
sphinx-autodoc-typehints==3.0.1 ; python_full_version == '3.10.*'
90+
sphinx-autodoc-typehints==3.1.0 ; python_full_version >= '3.11'
8891
sphinx-basic-ng==1.0.0b2
8992
sphinx-jinja2-compat==0.3.0
9093
sphinx-prompt==1.8.0 ; python_full_version < '3.10'

0 commit comments

Comments
 (0)