search

noi-techpark / odh-docs

Open Data Hub (http://opendatahub.com/) Documentation
http://opendatahub.readthedocs.io/en/latest/index.html
4 stars 4 forks source link

Verify compatibility issues of Sphinx 3.0.0b1 #103

Closed stefanodavid closed 4 years ago

stefanodavid commented 4 years ago

Yesterday was announced the release of Sphinx-3.0.0b1. [1] While we don't plan to upgrade Sphinx anytime soon (2.4.4 is used right now, and possibly 2.3 is available on RTD), it introduces a few backward-incompatible changes that should be evaluated before actually using it.

I open this issue for future references.

[1] https://github.com/sphinx-doc/sphinx/blob/3.0.x/CHANGES

stefanodavid commented 4 years ago

I just installed sphinx-3.0.3 via pip3 and compilation on my PC is almost perfect, the only issue is that glossary terms are now (seemingly) matched in a case-sensitive way, So I'll fix them manually.

stefanodavid commented 4 years ago

The only problem left with Sphinx-3.0.3 is with the sphinx-tabs extension, which causes a /usr/local/lib/python3.7/dist-packages/sphinx_tabs/tabs.py:341: RemovedInSphinx40Warning: The app.add_javascript() is deprecated. Please use app.add_js_file() instead. app.add_javascript(path) warning, which is outside my control, but it's not causing any harm at the moment.