-
Notifications
You must be signed in to change notification settings - Fork 69
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
fix: fix sphinx identifiers #714
Merged
Merged
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
google-cla
bot
added
the
cla: yes
This human has signed the Contributor License Agreement.
label
Dec 18, 2020
Codecov Report
@@ Coverage Diff @@
## master #714 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 26 26
Lines 1598 1602 +4
Branches 324 326 +2
=========================================
+ Hits 1598 1602 +4
Continue to review full report at Codecov.
|
software-dov
approved these changes
Dec 22, 2020
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Dec 22, 2020
🤖 I have created a release \*beep\* \*boop\* --- ## [0.39.0](https://www.github.com/googleapis/gapic-generator-python/compare/v0.38.0...v0.39.0) (2020-12-22) ### Features * allow warehouse name to be customized ([#717](https://www.github.com/googleapis/gapic-generator-python/issues/717)) ([7c185e8](https://www.github.com/googleapis/gapic-generator-python/commit/7c185e87cb4252b1f99ed121515814595f9492c4)), closes [#605](https://www.github.com/googleapis/gapic-generator-python/issues/605) ### Bug Fixes * fix sphinx identifiers ([#714](https://www.github.com/googleapis/gapic-generator-python/issues/714)) ([39be474](https://www.github.com/googleapis/gapic-generator-python/commit/39be474b4419dfa521ef51927fd36dbf257d68e3)), closes [#625](https://www.github.com/googleapis/gapic-generator-python/issues/625) [#604](https://www.github.com/googleapis/gapic-generator-python/issues/604) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please).
This was referenced Jan 18, 2022
This was referenced Jan 26, 2022
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.
Cross-references like
~.ImageAnnotatorClient
don't always work correctly with sphinx. This PR changes thesphinx()
method to always produce a full path likegoogle.cloud.vision_v1.ImageAnnotatorClient
.Also some other smaller changes:
.rst
page for each service, which improves readability for APIs that have (1) a lot of services or (2) a lot of methods in a service.services.rst
acts as an index page instead.undoc-members
to list enum attributes in generated docs (fixes enum classes are missing docstrings #625)nl=False
. Fixes Bullet lists in docstrings should end with blank lines #604noxfile.py
so folks using the self-service model can have generated docs.Returns:
{@api.name}
reference in thefrom_service_account..
. methods to reference the client type instead:class:
notation when specifying types for attributes (sphinx doesn't need it to create a link)