docs: specify the inherited-members directive for job classes #2244
Conversation
This file contains hidden or 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
It seems that versions of python earlier than 3.10 may have had issues processing inherited members annotations, and accidentally include inherited members by default. As we recently worked to excise older versions of python in this repo, it seems we're now correctly processing sphinx directives, which means we no longer emit docstrings for inherited members. This PR adds a minor sphinx directive to include inherited members for the job classes, and I've confirmed locally by running the `docsfx` nox job that the inherited members do now get included in the docfx_yaml output.
Linchin
approved these changes
Jul 21, 2025
This was referenced Jul 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
It seems that versions of python earlier than 3.10 may have had issues processing inherited members annotations, and accidentally include inherited members by default.
As we recently worked to excise older versions of python in this repo, it seems we're now correctly processing sphinx directives, which means we no longer emit docstrings for inherited members.
This PR adds a minor sphinx directive to include inherited members for the job classes, and I've confirmed locally by running the
docsfxnox job that the inherited members do now get included in the docfx_yaml output.internal: b/432470466