maintenance for sphinx 4.x #464
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
Adding a `prerelease` test environment for tox to allow a developer to fetch all pre-release versions of dependencies for a test run. This is primarily to help test against pre-release versions of Sphinx to help handle changes introduced in a new major release. Signed-off-by: James Knight <james.d.knight@live.com>
For releases of Sphinx pre-v4.x, signature descriptors could contain identifier entries wrapped in an emphasis node. In the most recent version of Sphinx (observed in 4.0.0b2), identifiers may not be wrapped in an emphasis node. Instead of relying on an emphasis node, use the class hint which identifiers an identifiers type [1] to build an `em` container. [1]: https://github.com/sphinx-doc/sphinx/blob/v3.5.4/sphinx/addnodes.py#L224-L226 Signed-off-by: James Knight <james.d.knight@live.com>
Sphinx has been refactoring [1][2] its implementation to adjust the use of the `default` alignment back to `None`, to follow with docutils. Adjusting a series of lines which rely on the `default` assignment as a hint for default alignment, where now an unset alignment applies the default alignment as well. [1]: sphinx-doc/sphinx#4550 (comment) [2]: sphinx-doc/sphinx#8690 Signed-off-by: James Knight <james.d.knight@live.com>
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.
storage: support emphasis of identifier values in signatures
For releases of Sphinx pre-v4.x, signature descriptors could contain identifier entries wrapped in an emphasis node. In the most recent version of Sphinx (observed in 4.0.0b2), identifiers may not be wrapped in an emphasis node. Instead of relying on an emphasis node, use the class hint which identifiers an identifiers type [1] to build an
emcontainer.storage: handle no-alignment as default alignment
Sphinx has been refactoring [2][3] its implementation to adjust the use of the
defaultalignment back toNone, to follow with docutils. Adjusting a series of lines which rely on thedefaultassignment as a hint for default alignment, where now an unset alignment applies the default alignment as well.[1]: https://github.com/sphinx-doc/sphinx/blob/v3.5.4/sphinx/addnodes.py#L224-L226
[2]: sphinx-doc/sphinx#4550 (comment)
[3]: sphinx-doc/sphinx#8690