doc: patch Sphinx to detect our @final for marking classes as final
#7826
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
nicoddemus
approved these changes
Oct 1, 2020
|
Rebased to fix a tiny conflict |
Thanks to Dominic Davis-Foster for code & assistance.
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.
Continuation to #7780, makes the
final classalso show up in the API Reference.Thanks to @domdfcoding for code & assistance.
Compared to @domdfcoding's code, I made it less accurate (just accepts any
@finalas an indicator, disregarding where it's imported from), but simpler and hopefully more robust against changes in Sphinx. Since it's only scoped to pytest it shouldn't be a problem.We also have a similar issue with
@overload, but that should take care of itself after #7811 is merged (as confirmed by the RTD build of that PR).