Add support for docutils 0.17 #1185
Conversation
This should'nt be a breaking change as backward compatibility is preserved so this change could go into 1.0 or wait until 1.1. I know a lot of users are asking for this so it might be nice to include this in 1.0. Fixes #1115
src/sass/_theme_rst.sass
Outdated
| @@ -16,22 +16,18 @@ | |||
| .rst-content | |||
| // Sphinx by default applies HxW style attributes to images. This fixes that oversite. | |||
| img | |||
| margin-bottom: $base-line-height | |||
There was a problem hiding this comment.
I'm assuming there will probably be unwanted side effects from this, img is a pretty generic selector. Is this on purpose? Looks like the original selector was a bit more specific, at .rst-content .section > img
|
Gave a quick test against Sphinx 4.1 + There is some probably unwanted spacing added with this PR, under the image in this hlist: On master:
On this PR:
Some unwanted spacing under an inline image:
More spacing was added here, but it actually looks better. If we want to undo the image spacing in this PR, I would make a separate PR with this change included:
Same with image spacing and this caption:
Probably a bit too much spacing here now:
|
It seems that browsers add some special default styling to header tags :( I found that for smaller heading tags, like h5 could give more padding then h1 tags... To fix this, everything should now just recieve the theme standard of 24px bottom margin.
…eme into docutils0.17.1
|
This was weird... Seems to be some user agent styling from the browser, it seems to give special bottom margins to To standardize this, I just made them all have a 24px bottom margin. |
This bug was introduced in #1185, it looks like the HTML4 selector changed to not include directly descendents of `.section` elements.
|
Is there an issue with |
Fixes bug where bullet lists lose their bullets. See
readthedocs/sphinx_rtd_theme#1115
readthedocs/sphinx_rtd_theme#1185
Does mean we use older version of Sphinx and docutils but seems OK.
This only affects building the docs in standalone mode for
development. For release we're using a custom theme anyway.
There's an old bug in sphinx_rtd_theme which made rendering bullet lists buggy. That bug since has been fixed, but sometimes pip-compile resolves to use the older buggier version of the theme. https://stackoverflow.com/questions/67542699/readthedocs-sphinx-not-rendering-bullet-list-from-rst-file/74355734 readthedocs/sphinx_rtd_theme#1115 readthedocs/sphinx_rtd_theme#1185
This should'nt be a breaking change as backward compatibility is preserved so this change could go into 1.0 or wait until 1.1.
I know a lot of users are asking for this so it might be nice to include this in 1.0.
Fixes #1115