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

should update CSS to reflect new docutils 0.17 HTML5 tags #9001

Closed
drammock opened this issue Mar 14, 2021 · 9 comments · Fixed by #9059
Closed

should update CSS to reflect new docutils 0.17 HTML5 tags #9001

drammock opened this issue Mar 14, 2021 · 9 comments · Fixed by #9059

Comments

@drammock
Copy link

drammock commented Mar 14, 2021

The HTML5 writer in docutils 0.17 writes the .. sidebar:: directive as the HTML5 aside tag (used to be div). This means that the rule in basic.css_t for styling those elements no longer applies, since the rule is written for div.sidebar instead of aside.sidebar:

div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
background-color: #ffe;
width: 40%;
float: right;
clear: right;
overflow-x: auto;
}

According to the docutils changelog linked above, other tags now being output are main, section, header, footer, figure, and figcaption. I haven't systematically checked for where / whether similar CSS mismatches are happening as a result, but I'd guess there are a few more besides the div -> aside issue that I ran into.

EDIT: crossref to mne-tools/mne-python#9031 where there are screenshots of a sidebar directive that is failing to get styled properly.

@tk0miya tk0miya added this to the 4.0.0 milestone Mar 15, 2021
@Daltz333
Copy link

Daltz333 commented Apr 4, 2021

A ping on this. docutils 0.17 has just gotten published and now breaks generation

@mgeier
Copy link
Contributor

mgeier commented Apr 4, 2021

I've just created #9059, which hopefully fixes this issue.

@drammock

According to the docutils changelog linked above, other tags now being output are main, section, header, footer, figure, and figcaption. I haven't systematically checked for where / whether similar CSS mismatches are happening as a result, but I'd guess there are a few more besides the div -> aside issue that I ran into.

If you find more errors, can you please create a new issue?

@ericholscher
Copy link
Contributor

Another option for now is just to pin to docutils <0.17. We did this on the RTD theme, until we have a chance to fully test and implement the changes.

@return42
Copy link

return42 commented Apr 8, 2021

Another option for now is just to pin to docutils <0.17

Another option I would vote for is to maintain a own fork and decouple docutils development from David Goodger: Each minor release brings new incompatibilities, each release of docutils cause problems in hundred of projects.

@tk0miya
Copy link
Member

tk0miya commented Apr 8, 2021

I feel such a reaction is very hysteric and intolerant. If you'd like to get the docutils project better, please join the project and help them. (or please vote to decouple Sphinx development from me also)

@tk0miya
Copy link
Member

tk0miya commented Apr 8, 2021

I merged #9059 to 3.5.x branch. So closing this now. Please file another issue if you find other troubles. Thanks,

@tk0miya tk0miya closed this as completed Apr 8, 2021
@return42
Copy link

return42 commented Apr 8, 2021

I feel such a reaction is very hysteric and intolerant.

Apologies my inappropriate comment .. but I'm annoyed that each minor release from docutils caused a cascade of problems.

If you'd like to get the docutils project better, please join the project

I had a look years ago ...the access to become team member is unusually difficult .. and personally I have a problem with sourceforge. / I know of some developers who would like to contribute to the project but don't, because the project management is a little bit idiosyncratic.

@ericholscher
Copy link
Contributor

I think the main goal here is more testing and communication, which is something everyone in the community can help and contribute to. Wearing my Read the Docs hat, we'd love to be able to work with sphinx & docutils to increase testing beta & development across the ecosystem, so hopefully we can catch some of these issues prior to them getting released.

We can talk more about it over at #9056 perhaps, instead of this old issue, but I think there's some productive work to be done here.

@andredias
Copy link

Disclaimer: I'm the author of rst2html5

I'd like to suggest using it instead of docutils' rst2html5. It has been stable for years and produces better results than docutils. Please, see its README.

fanghuaqi added a commit to Nuclei-Software/nuclei-sdk that referenced this issue May 19, 2021
see sphinx-doc/sphinx#9001

Signed-off-by: Huaqi Fang <578567190@qq.com>
fanghuaqi added a commit to Nuclei-Software/nuclei-sdk that referenced this issue May 19, 2021
see sphinx-doc/sphinx#9001

Signed-off-by: Huaqi Fang <578567190@qq.com>
brechtm added a commit to brechtm/rinohtype that referenced this issue May 21, 2021
An incompatibility between sphinx-rtd-theme and docutils prevents
updating docutils for now.
sphinx-doc/sphinx#9001
fanghuaqi added a commit to riscv-mcu/e203_hbirdv2 that referenced this issue May 25, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants