Upgrade to Sphinx 4.0.0 #1387
Merged
Upgrade to Sphinx 4.0.0 #1387
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changes: https://www.sphinx-doc.org/en/master/changes.html#release-4-0-0-released-may-09-2021 Things to note: - docutils updated to 0.17 https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-17-2021-04-03 the big change here is to use semantic elements, <div class="section"> is now <section>, I see this a whole bunch when I diff the output HTML. - supposedly some html themes break due to the docutils change, probably due to divs not matching, I don't see any visible breakage, so it should be fine - mathjax 3 https://docs.mathjax.org/en/latest/upgrading/whats-new-3.0.html it's faster to render, we need to tweak our configuration a bit, to camelCase, so updated it in conf.py I diffed the output html, some differences I noted: - div -> section as noted above - a new meta tag for Docutils - link tag for css, the type and href attributs swapped places - script tag for documetation_options, id and data-url_root swapped places - some css changes in sphinx css files
Co-authored-by: Ms2ger <Ms2ger@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
https://www.sphinx-doc.org/en/master/changes.html#release-4-0-0-released-may-09-2021
Things to note:
https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-17-2021-04-03
the big change here is to use semantic elements,
<div class="section">is now
<section>, I see this a whole bunch when I diff the output HTML.due to divs not matching, I don't see any visible breakage, so it should
be fine
https://docs.mathjax.org/en/latest/upgrading/whats-new-3.0.html it's
faster to render, we need to tweak our configuration a bit, to
camelCase, so updated it in conf.py
I diffed the output html, some differences I noted:
places