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.

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

Newest docutils (v0.17) breaks rendering #9061

Closed
kevinzakka opened this issue Apr 5, 2021 · 5 comments
Closed

Newest docutils (v0.17) breaks rendering #9061

kevinzakka opened this issue Apr 5, 2021 · 5 comments
Labels

Comments

@kevinzakka
Copy link

kevinzakka commented Apr 5, 2021

It seems the newest docutils has broken html rendering in a few places. I'm attaching screenshots showing the output of make html with 0.16 and comparing it to 0.17.

Screenshots

Your project
https://github.com/kevinzakka/torchkit

Environment info

  • OS: [e.g. mac OS]
  • Python version: [e.g. 3.8/3.9]
  • Sphinx version: [e.g. 3.5.2]
  • Sphinx extensions: [e.g. sphinx.ext.autodoc]
@kevinzakka
Copy link
Author

Oops, I missed #9059 .. Closing this for now!

@mgeier
Copy link
Contributor

mgeier commented Apr 5, 2021

This should fix the issue: #9053.

rkdarst added a commit to coderefinery/manuals that referenced this issue Apr 5, 2021
- This also seems to break <ul> list items somehow
- sphinx-doc/sphinx#9061
@rkdarst
Copy link
Contributor

rkdarst commented Apr 5, 2021

list items li in unordered lists ul is also broken (bullet point ::marker are missing). docutils!=0.17 also fixes it for me. I haven't dug much deeper yet.

rkdarst added a commit to coderefinery/sphinx-lesson that referenced this issue Apr 5, 2021
- Docutils==0.17 have some changes that break Sphinx rendering.
  Sphinx is working on it, but in the meantime we can fix some
  dependencies here until everything gets resolved.  This will also
  fix everyone that depends on us.
- This will be removed later, once most Sphinx installations get
  updated to handle it.
- sphinx-doc/sphinx#9061
- I propose a release soon after this
- Review:
  - General check
  - comment on release
  - comments on the general way we manage the requirements here?
@mgeier
Copy link
Contributor

mgeier commented Apr 5, 2021

@rkdarst I cannot reproduce the problem. Can you please create a new issue for this, ideally with example reST code and a screenshot? Please also specify which HTML theme you are using.

@rkdarst
Copy link
Contributor

rkdarst commented Apr 5, 2021

You are right, I could only reproduce it in sphinx_rtd_theme, not the default Sphinx theme. I filed the issue here: readthedocs/sphinx_rtd_theme#1115 . Reproducing my issue can be found in that issue.

I haven't dug deeper to see if there could be anything else to do in Sphinx itself, but browsing sphinx_rtd_theme's docs I don't see anything obvious. I guess there is possibility that each theme needs to update some things, but I know nothing about that so far.

ericholscher added a commit to ericholscher/sphinx that referenced this issue Apr 9, 2021
This will address the issues that the latest docutils release caused.
I think thi si a good practice in general to make sure we have a defined range of docutils versions,
given that they might change in the future.
Having this defined will mean that 3.x versions of Sphinx will always work,
even when docutils has advanced with additional backwards incompatible features.

Refs sphinx-doc#9065 sphinx-doc#9063 sphinx-doc#9061 sphinx-doc#9051
ericholscher added a commit to ericholscher/sphinx that referenced this issue Apr 9, 2021
This will address the issues that the latest docutils release caused.
I think thi si a good practice in general to make sure we have a defined range of docutils versions,
given that they might change in the future.
Having this defined will mean that 3.x versions of Sphinx will always work,
even when docutils has advanced with additional backwards incompatible features.

Refs sphinx-doc#9065 sphinx-doc#9063 sphinx-doc#9061 sphinx-doc#9051
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants