search

teuben / nemo

a Stellar Dynamics Toolbox (Not Everybody Must Observe)
https://astronemo.readthedocs.io
GNU General Public License v2.0
57 stars 42 forks source link

sphinx 4.1.0 (e.g. on readthedocs now) is failing to compile html #74

Closed teuben closed 3 years ago

teuben commented 3 years ago

Recently readthedocs must have upgraded to sphinx 4.1.0, and it's now failing with:

 Could not import extension sphinx.builders.epub3 (exception: cannot import name 'RemovedInSphinx40Warning' from 'sphinx.deprecation'

which you can locally invoke via

  cd $NEMO/doc 
  pip install -U -r requirements.txt

after this "make html" fails in the source directory.

teuben commented 3 years ago

I sympathize with this comment: https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/ stuff like this makes me wonder if it was the right decision to convert to sphinx.

teuben commented 3 years ago

https://github.com/sphinx-doc/sphinx/issues/9434 offers a local workaround

  pip install -U sphinxcontrib-htmlhelp
  pip install -U sphinxcontrib-serializinghtml

a fix on readthedocs itself will surely be coming soon.

teuben commented 3 years ago

Modified the requirements.txt to contain sphinx>=4.1.1 made it work again.