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

fix: fix sphinx identifiers #714

Merged
merged 11 commits into from
Dec 22, 2020
Merged

fix: fix sphinx identifiers #714

merged 11 commits into from
Dec 22, 2020

Conversation

busunkim96
Copy link
Contributor

@busunkim96 busunkim96 commented Dec 18, 2020

Cross-references like ~.ImageAnnotatorClient don't always work correctly with sphinx. This PR changes the sphinx() method to always produce a full path like google.cloud.vision_v1.ImageAnnotatorClient.

Also some other smaller changes:

  • Generate a separate .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.
  • Add pagers to the generated docs
  • Use undoc-members to list enum attributes in generated docs (fixes enum classes are missing docstrings #625)
    image
  • Add newlines after bulleted lists by removing nl=False. Fixes Bullet lists in docstrings should end with blank lines #604
  • Add a 'docs' session to the templated noxfile.py so folks using the self-service model can have generated docs.
  • Fix reference to LRO result type in Returns:
  • Fix {@api.name} reference in the from_service_account... methods to reference the client type instead
  • Remove :class: notation when specifying types for attributes (sphinx doesn't need it to create a link)

@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Dec 18, 2020
@codecov
Copy link

codecov bot commented Dec 21, 2020

Codecov Report

Merging #714 (68e69a0) into master (edadb22) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #714   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           26        26           
  Lines         1598      1602    +4     
  Branches       324       326    +2     
=========================================
+ Hits          1598      1602    +4     
Impacted Files Coverage Δ
gapic/schema/wrappers.py 100.00% <ø> (ø)
gapic/schema/metadata.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update edadb22...68e69a0. Read the comment docs.

@busunkim96 busunkim96 marked this pull request as ready for review December 21, 2020 23:31
@busunkim96 busunkim96 requested a review from a team as a code owner December 21, 2020 23:31
@busunkim96 busunkim96 changed the title docs: fix sphinx identifiers fix: fix sphinx identifiers Dec 21, 2020
@busunkim96 busunkim96 merged commit 39be474 into master Dec 22, 2020
@busunkim96 busunkim96 deleted the fix-sphinx branch December 22, 2020 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

enum classes are missing docstrings Bullet lists in docstrings should end with blank lines
2 participants