feat(docs): publish Client libraries help to reference documentation#16575
feat(docs): publish Client libraries help to reference documentation#16575bshaffer wants to merge 7 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new help package for documentation, including a DocFX helper script and Nox configuration. Key feedback includes concerns about shadowing the built-in help() function, unused imports and parameters in docfx_helper.py, and the need for explicit encoding during file operations. Improvements were also suggested for argument parsing and the removal of legacy Python 2 imports.
bshaffer
force-pushed
the
client-libraries-help
branch
from
a61bd74 to
4aa9b08
Compare
bshaffer
changed the title
|
@parthea this is ready for review 🙏 ! |
Co-authored-by: Anthonios Partheniou <partheniou@google.com> Co-authored-by: Brent Shaffer <betterbrent@google.com>
daniel-sanche
left a comment
daniel-sanche
left a comment
There was a problem hiding this comment.
I added a few suggestions for the doc contents, but overall LGTM
| [google-cloud-spanner](https://docs.cloud.google.com/python/docs/reference/spanner/latest)) | ||
| are mostly higher level abstractions over the underlying API. See the documentation | ||
| for those individual libraries for details; the documentation here is primarily | ||
| aimed at the autogenerated libraries. |
There was a problem hiding this comment.
See the documentation for those individual libraries for details; the documentation here is primarily aimed at the autogenerated libraries.
nit: the wording here is a little awkward, referring to both as the documentation
|
|
||
| All Google Cloud Libraries for Python are available from [PyPI](https://pypi.org) and can be installed | ||
| using `pip`. If you wish to install a pre-release version, you can specify the version explicitly | ||
| with the installation command. |
There was a problem hiding this comment.
nit: it might be useful to show examples here:
All Google Cloud Libraries for Python are available from PyPI and can be installed using
pip:
pip install google-cloud-translate
If you wish to install a pre-release version, you can specify the version explicitly with the installation command:
pip install google-cloud-translate==3.13.0rc0
| with the installation command. | ||
|
|
||
| The libraries can be installed in any regular environment, including virtual environments (recommended), | ||
| containerized applications, and web frameworks like Django or Flask. |
There was a problem hiding this comment.
I'm not sure what that part about web frameworks is referring to. Web frameworks wouldn't be a deployment target like the others
| For the translation example, we'll create a new directory, set up a virtual environment, | ||
| and install the package. | ||
|
|
||
| Note that for simplicity, the sample code below uses synchronous calls. Most libraries also provide |
There was a problem hiding this comment.
Maybe the part about synchronous calls should be moved closer to the code, in the "Create a client" section?
|
|
||
| ## Make requests | ||
|
|
||
| The Google Cloud Libraries use [Protocol Buffers](https://protobuf.dev) |
There was a problem hiding this comment.
Maybe worth mentioning most libraries also support rest transports?
3 participants
b/450298584
Publishes documentation to https://cloud.google.com/python/docs/reference under "Client libraries help".
This currently only contains the
README.rstcontents from the root of this repo. We will expand this to add more once we've confirmed this is deploying as expected.