Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix sphinxify deprecation warnings with sphinx 2.2 #29095

Closed
antonio-rojas opened this issue Jan 28, 2020 · 9 comments
Closed

Fix sphinxify deprecation warnings with sphinx 2.2 #29095

antonio-rojas opened this issue Jan 28, 2020 · 9 comments
Labels
c: documentation p: major / 3 t: bug
Milestone
sage-9.1

Comments

@antonio-rojas
Copy link
Contributor

With sphinx 2.2, sphinxify throws a deprecation warning:

/usr/share/doc/sage/common/themes/sage/search.html:22: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead.

Fix taken from rtd_theme [1]

[1] readthedocs/sphinx_rtd_theme@4a7dc08

CC: @kiwifb @timokau @isuruf

Component: documentation

Author: Antonio Rojas

Branch/Commit: e759f94

Reviewer: John Palmieri

Issue created by migration from https://trac.sagemath.org/ticket/29095
@antonio-rojas antonio-rojas added this to the sage-9.1 milestone Jan 28, 2020
@antonio-rojas
Copy link
Contributor Author

Branch: u/arojas/fix_sphinxify_deprecation_warnings_with_sphinx_2_2

@antonio-rojas
Copy link
Contributor Author

Commit: e759f94

@antonio-rojas
Copy link
Contributor Author

New commits:

e759f94Fix "To modify script_files in the theme is deprecated" warning with sphinx 2.2

@antonio-rojas
Copy link
Contributor Author

Author: Antonio Rojas

@antonio-rojas

This comment has been minimized.

Sign in to view
@antonio-rojas
Copy link
Contributor Author

comment:3

With this fix, everything works fine at runtime with sphinx 2.2. Building is a different topic (#28856)

@jhpalmieri
Copy link
Member

comment:4

When docbuilding I also see warnings

RemovedInSphinx30Warning: function based directive support is now deprecated. Use class based directive instead.

but those can be fixed on another ticket. (This is with Sphinx 2.3.1, which is what is available at https://pypi.org/project/Sphinx/#files.)

@jhpalmieri
Copy link
Member

Reviewer: John Palmieri

@vbraun
Copy link
Member

vbraun commented Jan 31, 2020

Changed branch from u/arojas/fix_sphinxify_deprecation_warnings_with_sphinx_2_2 to e759f94

@vbraun vbraun closed this as completed in b4956f6 Jan 31, 2020
@mkoeppe mkoeppe mentioned this issue Aug 22, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: documentation p: major / 3 t: bug
Projects
None yet
Milestone
sage-9.1
Development

No branches or pull requests
3 participants
@vbraun @jhpalmieri @antonio-rojas