You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
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?
I have approached it with Sphinx, Github actions and Github pages so we can publish it quickly/easily.
Let me know any feedback. Thanks
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: