feat(docs): publish Client libraries help to python reference documen…#16575
feat(docs): publish Client libraries help to python reference documen…#16575bshaffer wants to merge 2 commits intogoogleapis:mainfrom
Conversation
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.
| python_requires=">=3.10", | ||
| include_package_data=True, | ||
| zip_safe=False, | ||
| packages=["help"], |
There was a problem hiding this comment.
Naming the package help shadows the Python built-in help() function. This can lead to confusion and subtle bugs when users try to use the built-in help system after importing this package. It is strongly recommended to use a more specific name, such as google_cloud_help.
There was a problem hiding this comment.
I'll wait to hear the opinion of a repo maintainer before changing this. Happy to rename it to whatever.
|
I cannot seem to get the final job to pass, and would love some feedback on how to fix it... this is passing locally for me, so I am not sure how to fix it! |
a61bd74 to
4aa9b08
Compare
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.