8000 chore: fix docs build by parthea · Pull Request #1488 · googleapis/gapic-generator-python · GitHub
[go: up one dir, main page]
Skip to content

chore: fix docs build #1488

New issue

Have a question about this project? Sign up for a free GitHub account 8000 to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Nov 11, 2022
Merged

chore: fix docs build #1488

merged 5 commits into from
Nov 11, 2022

Conversation

parthea
Copy link
Contributor
@parthea parthea commented Nov 11, 2022 •
edited
Loading

This PR removes the undoc-members option of sphinx to address the error duplicate object description seen in the docs build for downstream clients. See build log here

See the definition for undoc-members here:

:undoc-members: (no value)
If set, autodoc will also generate document for the members not having docstrings:

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-undoc-members

@parthea
chore: fix docs build
d89a8a1 
This addresses the error "duplicate object description" seen in the docs build of downstream clients.
@parthea parthea requested review from a team as code owners November 11, 2022 13:17
@product-auto-label product-auto-label bot added the size: xs Pull request size is extra small. label Nov 11, 2022
dandhlee
dandhlee approved these changes Nov 11, 2022
View reviewed changes
Copy link
Contributor
@dandhlee dandhlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be a problem for autogenerated clients. For handwritten libraries the maintainers have choice to add this themselves, so LGTM.

@parthea parthea mentioned this pull request Nov 11, 2022
Merged
1 task
This was referenced Nov 11, 2022
Merged
Merged
Merged
@parthea parthea merged commit 23d20c1 into main Nov 11, 2022
@parthea parthea deleted the parthea-patch-3 branch November 11, 2022 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dandhlee dandhlee dandhlee approved these changes

Assignees
No one assigned
Labels
size: xs Pull request size is extra small.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@parthea @dandhlee
0