Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Force html4 writer for sphinx 2 #15196

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.

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

Merged
merged 4 commits into from
Sep 7, 2019
Merged

Force html4 writer for sphinx 2 #15196

merged 4 commits into from
Sep 7, 2019

Conversation

dstansby
Copy link
Member

@dstansby dstansby commented Sep 5, 2019

Sphinx 2 by default uses a html5 writer, that changes the outputted html, causing the issues mentioned in #13591. In order to allow the use of sphinx 2, without having to change our CSS, makes sphinx 2 use the html4 writer that sphinx 1 also uses.

Possibly we will want to migrate/upgrade to the html5 writer, but changing the CSS to match is a pain (see #14105 for my aborted attempt to do this) so this provides a solution to use sphinx 2 in the medium term.

Fixes #13591

@tacaswell tacaswell added this to the v3.2.0 milestone Sep 5, 2019
@timhoffm
Copy link
Member

timhoffm commented Sep 6, 2019

Could you please give a little more context? Does the patch fix all sphinx 2 issues? Do we want/need a strategy to migrate to html5 later on?

@dstansby
Copy link
Member Author

dstansby commented Sep 6, 2019

Sorry, have updated the original comment above. I've also re-targeted this to 3.3.0, since I think we should give it a bit of time for any potential issues to be discovered on devdocs before using this in a release.

@dstansby dstansby modified the milestones: v3.2.0, v3.3.0 Sep 6, 2019
@NelleV
Copy link
Member

NelleV commented Sep 7, 2019

Thanks @dstansby !
Should we open a ticket for the html5 migration or is it already opened?

@NelleV NelleV merged commit 84e531b into matplotlib:master Sep 7, 2019
@dstansby dstansby deleted the sphinx2 branch September 7, 2019 10:40
@tacaswell tacaswell modified the milestones: v3.3.0, v3.2.0 Sep 7, 2019
@tacaswell
Copy link
Member

It is on master and we haven't branched yet (probably tonight) so it will be in 3.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Style issues when building the docs with (future) Sphinx 2.0
4 participants