Add google.adk.cli.fast_api.get_fast_api_app to Python API Reference#1335
Add google.adk.cli.fast_api.get_fast_api_app to Python API Reference#1335olliefr wants to merge 3 commits intogoogle:mainfrom
google.adk.cli.fast_api.get_fast_api_app to Python API Reference#1335Conversation
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Currently blocked by google/adk-python#4560 |
|
Thanks for the PR and for the thorough investigation in google/adk-python#4500! The Python API reference docs are built manually using a Sphinx config that currently lives internally (not in adk-docs or adk-python). Only the built HTML output is committed to this repo, so the The good news is that this PR shouldn't be needed. The .. automodule:: google.adk.cli
:members:
:undoc-members:
:show-inheritance:Once the linked adk-python PR is merged and adds So the path forward is:
I'm going to close this PR since no adk-docs changes are needed. Thank you for the contribution to make these API docs more discoverable and for the companion PR in adk-python! |
|
@koverholt thank you for the explanation. Now I understand what's going on. It might be worth adding a note to the |
This is my first PR to ADK docs so extra help is appreciated.
I'm trying to add some missing information to the Python API Reference. There is an open issue with full details: google/adk-python#4500
My understanding is that updating Python API Reference requires changes in two places:
adk-python:Promote
google.adk.cli.fast_api.get_fast_api_appto public namespace adk-python#4560adk-docsPython API Reference source file to add new modules to the list. This PR is supposed to take care of it.Looking at the past PRs in this repo, I could not figure out what process to follow to update the Python API Reference pages only. It appears that PRs for such updates contain generated final versions of the API Reference docs pages.
In this PR, I updated the
docs/api-reference/python/_sources/google-adk.rst.txtto include the right module, but I don't know how to regenerate the HTML files for the API Reference pages.Summary
Issue: google/adk-python#4500
Related PRs: google/adk-python#4560
Help needed
Hello, @joefernandez! Could you please help me to understand how I can generate the updated API Reference docs pages?
I suppose I need to end up with something like #1311.