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

Setup: Require docutils<0.17' #1113

Closed
wants to merge 1 commit into from
Closed

Setup: Require docutils<0.17' #1113

wants to merge 1 commit into from

Conversation

Blendify
Copy link
Member

@Blendify Blendify commented Apr 5, 2021 •
edited
Loading

Docutils 0.17 changes the html output for some markup, until support is added to properly style this new markup we should pin to use an older version.

It may not be a bad idea to keep a pinned version in the theme to prevent this issue in the future.

Fixes #1112

If possible this should be committed into its own 0.5.2 release ASAP!

@Blendify
Setup: Require docutils<0.17'
7afbe04 
Docutils 0.17 changes some rendering of properties, until support is added we should probably pin to use an older version.

I may not be a bad idea to keep a pinned version in the theme to prevent this issue in the future.
@Blendify Blendify requested review from agjohnson, stsewd and a team April 5, 2021 03:43
@Blendify Blendify mentioned this pull request Apr 5, 2021
Closed
@JWCook
Copy link

JWCook commented Apr 5, 2021 •
edited
Loading

I just discovered this as well (in requests-cache/requests-cache#218). Specifically, I found that the semantic tags output by the new HTML5 writer (https://docutils.sourceforge.io/RELEASE-NOTES.html#id46) break list formatting in sphinx-rtd-theme. For example, <div class="section"> elements are now <section>.

@ericholscher
Copy link
Member

@Blendify Thanks for jumping on this. I'll try and get it released today. My current plan is to just branch from 0.5.1 and just apply this patch for a 0.5.2. There's some backwards incompatible changes in master that I don't want to ship to everyone just for a bugfix. Does that make sense?

@Blendify
Copy link
Member Author

Blendify commented Apr 5, 2021

Yes that that was my goal with this patch. It was a bit late when I was looking into fixing this. Let me know if you need me to rebase this patch.

@ericholscher
Copy link
Member

@Blendify Sounds good. I'll get it shipped here soon. I think I can just cherrypick it onto a branch off 0.5.1. 👍

@ericholscher
Copy link
Member

The release PR is now here: #1114

@Blendify
Copy link
Member Author

Blendify commented Apr 5, 2021

This got merged in a seperate commit see ca2719b

@Blendify Blendify closed this Apr 5, 2021
@Blendify Blendify deleted the docutils-17 branch April 5, 2021 17:16
sechkova added a commit to sechkova/tuf that referenced this pull request Aug 9, 2021
@sechkova
Pin docutils version
b81b95e 
Docutils versions >=0.17 have incompatibilites with
sphinx-rtd-theme and fail to render some features.
Pin the version until readthedocs release their fix
(readthedocs/sphinx_rtd_theme#1113).

Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
@jku jku mentioned this pull request Feb 8, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agjohnson agjohnson Awaiting requested review from agjohnson

@stsewd stsewd Awaiting requested review from stsewd

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

broken alignment for captions in toctrees in ver. 0.5.1
3 participants
@Blendify @JWCook @ericholscher