Skip to content

Add google.adk.cli.fast_api.get_fast_api_app to Python API Reference#1335

Closed
olliefr wants to merge 3 commits intogoogle:mainfrom
olliefr:olliefr-4500
Closed

Add google.adk.cli.fast_api.get_fast_api_app to Python API Reference#1335
olliefr wants to merge 3 commits intogoogle:mainfrom
olliefr:olliefr-4500

Conversation

@olliefr
Copy link
Contributor

@olliefr olliefr commented Feb 23, 2026

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:

  1. Exporting the desired symbol(s) to public namespace in adk-python:
    Promote google.adk.cli.fast_api.get_fast_api_app to public namespace adk-python#4560
  2. Updating the adk-docs Python 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.txt to 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.

@netlify
Copy link

netlify bot commented Feb 23, 2026

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit 66894ae
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/699de3660611a20008d748a5
😎 Deploy Preview https://deploy-preview-1335--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@olliefr
Copy link
Contributor Author

olliefr commented Feb 24, 2026

Currently blocked by google/adk-python#4560

@koverholt
Copy link
Collaborator

koverholt commented Feb 24, 2026

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 _sources/google-adk.rst.txt file is just a build artifact, not the actual source. (Sorry for the confusion on this, we're always working to streamline these processes!)

The good news is that this PR shouldn't be needed. The google-adk.rst that we use internally already has:

.. automodule:: google.adk.cli
    :members:
    :undoc-members:
    :show-inheritance:

Once the linked adk-python PR is merged and adds get_fast_api_app and AdkWebServer to google.adk.cli.__init__.py via __all__, the next docs generation will pick them up automatically with no RST changes required.

So the path forward is:

  1. Wait for the linked PR to be merged: Promote google.adk.cli.fast_api.get_fast_api_app to public namespace adk-python#4560
  2. @joefernandez will regenerate the Python API reference docs at the next release, and the new symbols will appear

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 koverholt closed this Feb 24, 2026
@olliefr
Copy link
Contributor Author

olliefr commented Feb 24, 2026

@koverholt thank you for the explanation. Now I understand what's going on. It might be worth adding a note to the adk-docs contributing guide explaining the current process for API docs' generation because the API docs are handled differently from the rest of the docs.

@koverholt
Copy link
Collaborator

@olliefr, good idea since this comes up regularly! I opened #1339 to add guidance on API/CLI reference docs contributions. Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants