search

paris-saclay-cds / ramp-workflow

Toolkit for building predictive workflows on top of pydata (pandas, scikit-learn, pytorch, keras, etc.).
https://paris-saclay-cds.github.io/ramp-docs/
BSD 3-Clause "New" or "Revised" License
68 stars 43 forks source link

Deprecation of add_javascript and add_stylesheet in Sphinx #278

Closed albertcthomas closed 3 years ago

albertcthomas commented 3 years ago

From Sphinx 4.0, we can no longer use add_javascript and add_stylesheet, they should be replaced by add_js_file() and add_css_file(). See https://www.sphinx-doc.org/en/master/extdev/deprecated.html

This is causing circle to fail, see #277 and #276.

Do we want to keep a sphinx version lower than 4? or should I go on with the change?

rth commented 3 years ago

I think for now, we could just pin sphinx to <4.0 as the release is recent I'm not sure that all sphinx plugins had time to migrate / make new compatible release. Then after a few months we could update the sphinx version.

Or update now, but one would need to visually compare the generated docs before/after to make sure nothing got broken. As you prefer.

albertcthomas commented 3 years ago

I'll pin sphinx to <4.0 for now, we can update it later.