Address Sphinx 2 compatibility issues #838
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agjohnson
added
the
PR: work in progress
This was referenced Oct 19, 2019
jessetan
reviewed
Oct 25, 2019
Closed
|
Added a method to also test the badge only css and I found a maybe sphinx 2 related bug. I added a switcher debug link:
|
jessetan
previously requested changes
Mar 21, 2020
|
@agjohnson can you please update this patch so the tests pass? |
|
I am currently finishing up this PR and I will be breaking out some of the unrelated work into separate PRs. I am resolving the remaining issue with field lists, definition lists, option lists, and footnotes with CSS |
agjohnson
force-pushed
the
agj/fix-dl-styles
branch
3 times, most recently
from
d9ab09a to
34e7656
Compare
|
Rebased and should be ready for final review! I've enabled PR builder, though the assets look cached at the moment. PR builds should use the locally available theme for testing, though we should probably be using |
This was referenced May 2, 2020
This was referenced May 3, 2020
ericholscher
removed
the
PR: work in progress
ericholscher
approved these changes
May 4, 2020
davidfischer
approved these changes
May 4, 2020
There was a problem hiding this comment.
Classifier delimiter is not shown with Sphinx >=2.0.0 #746 did not appear to be fixed in my testing. While I saw the same styling as Sphinx 1.8 (Definition list display different in Sphinx 2.1 #800), the classifier was collapsed into the existing text.This appears to be fixed in the SASS but not in the generated CSS.- While option lists (Option lists display different in Sphinx 2.1 #801) and are different, I agree that the new HTML5 styling is better. If people want the old display, I guess they can stick with the HTML4 writer
This looks great!
This is using CSS `grid` on the html5 writer, which is mostly supported by now.
This call was added in 1.6
Co-authored-by: David Fischer <david@readthedocs.org>
agjohnson
force-pushed
the
agj/fix-dl-styles
branch
from
fa363f8 to
f4c56d0
Compare
|
Thanks for review everyone! I'll move on to cutting a release candidate this afternoon. |
whitequark
added a commit
to amaranth-lang/amaranth
that referenced
this pull request
May 17, 2020
To render correctly, the docs require: * pygments/pygments#1441 * readthedocs/sphinx_rtd_theme#838
gforsyth
added a commit
to gforsyth/dask-sphinx-theme
that referenced
this pull request
Oct 2, 2020
This fix updates the `layout.html` with changes I grabbed from readthedocs/sphinx_rtd_theme#838 that relate to the version of the `htmlwriter` that is used. This should resolve dask/dask#6696 once a new release of the theme is cut (I've bumped the version in `__init__.py`) and the update is pulled in there.
mrocklin
pushed a commit
to dask/dask-sphinx-theme
that referenced
this pull request
Oct 2, 2020
This fix updates the `layout.html` with changes I grabbed from readthedocs/sphinx_rtd_theme#838 that relate to the version of the `htmlwriter` that is used. This should resolve dask/dask#6696 once a new release of the theme is cut (I've bumped the version in `__init__.py`) and the update is pulled in there. * Switch back to `extends` from rtd theme
This was referenced Nov 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main change here is that we load information into the template so
that CSS can make decisions about what element hierarchy it can expect,
instead of covering both html4 and html5 writer with a single set of
rules. I also fixed the tox config so that it generates docs for
testing.
This is also in part going to revert the changes in #785. Instead of
maintaining a list of
dlclasses to apply the domain styles to, thisPR instead maintains a list of definition list classes to not apply
the domain definition list styling too. There are too many possibilities
to cover with an include list.
Fixes #800
Fixes #801
Fixes #803
Fixes #831
Fixes #802
Fixes #798
Fixes #799
Fixes #741
Fixes #746
Fixes #855
Note for issues that will be closed by this PR
I will be cutting a development release for the theme as soon as this PR is merged. We could use some testing at that point for the release
0.5rc1, which will be available on PyPI (hopefully) early next week.