search

google-gemini / generative-ai-python

The official Python library for the Google Gemini API
https://pypi.org/project/google-generativeai/
Apache License 2.0
1.62k stars 322 forks source link

Publish Python API docs somewhere #590

Open markmcd opened 1 month ago

markmcd commented 1 month ago

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

honnibal commented 1 month ago

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.

vi-shruti commented 1 month ago

Submitted a request addressing this.

bhargavyagnik commented 2 weeks ago

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? I have approached it with Sphinx, Github actions and Github pages so we can publish it quickly/easily. Let me know any feedback. Thanks