This repository was archived by the owner on Mar 26, 2026. It is now read-only.
chore: fix docs build#1488
Merged
Merged
Conversation
This addresses the error "duplicate object description" seen in the docs build of downstream clients.
dandhlee
approved these changes
Nov 11, 2022
Contributor
dandhlee
left a comment
dandhlee
left a comment
There was a problem hiding this comment.
This should not be a problem for autogenerated clients. For handwritten libraries the maintainers have choice to add this themselves, so LGTM.
1 task
This was referenced Nov 11, 2022
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 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.
This PR removes the
undoc-membersoption of sphinx to address the errorduplicate object descriptionseen in the docs build for downstream clients. See build log hereSee the definition for
undoc-membershere:https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-undoc-members