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

chore: update sphinx arrangement to remove duplicate entries on cloudsite #790

Merged
merged 5 commits into from May 27, 2022

Conversation

cojenco
Copy link
Contributor

@cojenco cojenco commented May 13, 2022

As part of the docs revamp, remove duplicate entries in python/docs/reference/storage

For example, module Bucket appears both in https://cloud.google.com/python/docs/reference/storage/latest/buckets and https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.bucket

Collaborated with dandhlee@ on rearranging the sphinx arrangement. This PR

  • removes this extra entries while keeping the rest of the documentation intact
  • revises sphinx tags that are incorrectly used as region tags
  • clean up ACL docstrings

Verified that the documentation generated looks correct. Follow-up work tracked in internal doc.

Fixes internal b/232410558

@product-auto-label product-auto-label bot added size: s Pull request size is small. api: storage Issues related to the googleapis/python-storage API. labels May 13, 2022
@snippet-bot
Copy link

snippet-bot bot commented May 13, 2022

Here is the summary of changes.

You are about to delete 41 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added size: l Pull request size is large. and removed size: s Pull request size is small. labels May 14, 2022
@cojenco cojenco changed the title chore: move module docs under storage chore: update sphinx arrangement to remove duplicate entries on cloudsite May 14, 2022
@cojenco cojenco added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@cojenco cojenco added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@cojenco cojenco added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@cojenco cojenco added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 27, 2022
@cojenco cojenco marked this pull request as ready for review May 27, 2022 18:17
@cojenco cojenco requested review from a team as code owners May 27, 2022 18:17
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.

Cloud RAD likely does not have support for .. literalinclude (I think I remember this was an issue in other libraries too) but we can deal with it later. LGTM! 🚀

@cojenco cojenco merged commit 18bbbd3 into googleapis:main May 27, 2022
@cojenco cojenco deleted the docstree branch November 16, 2023 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/python-storage API. size: l Pull request size is large.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants