Skip to content

Commit a2ea376

Browse files
committed
welcome to doc dependency hell
sphinx-rtd-theme 2.0.0 declares that it is incompatible with sphinx 8. As a result, with the old requirements-dev.txt, sphinx 8 and sphinx-rtd-theme 0.mumble are installed, as sphinx-rtd-theme 0.mumble did NOT declare an explicit incompatibility with sphinx 8. This pairing emphatically does NOT work, giving the error `UndefinedError("'style' is undefined")` during doc building. For all these AWESOME packages, specify a dependency range. This is sure to prevent future breakage 😉
1 parent 856f282 commit a2ea376

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

doc/conf.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@
1616
import re
1717
import subprocess
1818
import sys
19+
import pathlib
1920

20-
sys.path.insert(0, os.path.abspath("."))
21+
ROOT = pathlib.Path(__file__).absolute().parent.parent
22+
sys.path.insert(0, str(ROOT / "src"))
2123

2224

2325
# -- Project information -----------------------------------------------------

requirements-dev.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ pre-commit
1414
python-dateutil
1515
requests; implementation_name=="cpython"
1616
setuptools>=68; implementation_name=="cpython"
17-
sphinx
18-
sphinx-autodoc-typehints
19-
sphinx-rtd-theme
17+
sphinx>=8.0.2,<9
18+
sphinx-autodoc-typehints>=2.4.1,<3
19+
sphinx-rtd-theme>=3.0.0rc1,<4
2020
twine; implementation_name=="cpython"
2121
types-beautifulsoup4; implementation_name=="cpython"
2222
types-python-dateutil; implementation_name=="cpython"

0 commit comments

Comments
 (0)