-
Notifications
You must be signed in to change notification settings - Fork 414
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
Publish Python API docs somewhere #590
Comments
I would very much like this, and actually I came to the issues page just now to ask for it :) I actually find this a weak point of the Google Cloud Python SDK docs in general. It makes sense that there's one page about the underlying functionality, with an embedded widget that shows code examples for the various SDKs, e.g.: https://ai.google.dev/gemini-api/docs/quickstart?lang=python . This is a good docs page; it does what it's supposed to be doing. But pages like this aren't a replacement for an API reference of a particular SDK (e.g. Python). I need both. |
Submitted a request addressing this. |
Hi @markmcd , could you please check out API Docs. There are some broken links but search has correct ones and thus check it out from there, working on the issue with links from the markdown. It could be refined from this version with improvements and your suggestions. Is this what you are looking for? |
Description of the feature request:
The Python API docs are just markdown/HTML files in the docs/ directory. We should publish them somewhere like readthedocs or a GitHub page so that the content is rendered in an easily navigable way.
What problem are you trying to solve with this feature?
Improving Python API doc usability.
Any other information you'd like to share?
No response
The text was updated successfully, but these errors were encountered: