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

doc: patch Sphinx to detect our @final for marking classes as final #7826

Merged
merged 1 commit into from
Oct 3, 2020

Conversation

bluetech
Copy link
Member

@bluetech bluetech commented Oct 1, 2020

Continuation to #7780, makes the final class also 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 @final as 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).

@bluetech
Copy link
Member Author

bluetech commented Oct 3, 2020

Rebased to fix a tiny conflict

Thanks to Dominic Davis-Foster for code & assistance.
@bluetech bluetech merged commit 5efddd3 into pytest-dev:master Oct 3, 2020
@bluetech bluetech deleted the doc-final branch October 6, 2020 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants