Skip to content

Commit

Permalink
Looking at the error log more carefully, I see that Sphinx 8.1.3 is b…
Browse files Browse the repository at this point in the history
…eing used, which is pulling in docutils 0.21.2. We need to pin both Sphinx and docutils versions to be compatible with m2r2. Let's modify the requirements.txt:

requirements.txt
Key changes:
Added sphinx<7.0 to use an older version compatible with docutils 0.16
Kept docutils==0.16 which has the required reprunicode attribute
Kept m2r2==0.2.7 which is known to work with these versions
Added sphinx_rtd_theme<1.0 to ensure theme compatibility
This combination of version constraints should work together while maintaining all the functionality you need, including mermaid diagrams.
  • Loading branch information
endolith committed Nov 18, 2024
1 parent 2506a9d commit 491dc1a
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
docutils>=0.19
sphinx<7.0
docutils==0.16
-e .
numpydoc
m2r2>=0.3.3
m2r2==0.2.7
sphinxcontrib.mermaid
sphinx_rtd_theme
sphinx_rtd_theme<1.0
sphinxcontrib-apidoc

0 comments on commit 491dc1a

Please sign in to comment.