Repository navigation
No docs are generated for google.adk.cli module for Python API Reference聽#4500
Description
馃敶 Required Information
Describe the Bug:
ADK docs include code examples that make use of get_fast_api_app from google.adk.cli.fast_api module: one such docs page.
Oddly enough, the Python API Reference has no documentation generated for google.adk.cli as of now: api reference for google.adk.cli
This is odd, because the module actually does have docstrings: module source file
Steps to Reproduce:
Search the API Reference for get_fast_api_app. Nothing found.
OR
Open the API Reference and select google.adk.cli on the navbar. There is no docs there.
Expected Behavior:
The docstrings are in the source code so I would expect the API Reference to pick that up when the docs are generated.
Observed Behavior:
As explained in the steps to reproduce section.
Environment Details:
- ADK Library Version (pip show google-adk): N/A
- Desktop OS: N/A
- Python Version (python -V): N/A
Model Information:
- Are you using LiteLLM: N/A
- Which model is being used: N/A
馃煛 Optional Information
Regression:
Did this work in a previous version of ADK? If so, which one?
I don't know.
Screenshots / Video:
How often has this issue occurred?:
- Always (100%)
Activity
klateefa commentedon Feb 17, 2026
@olliefr Thanks for reporting!
The API docs are missing because the module
google.adk.cli.fast_apiis not currently included in the documentation build. The docs generator only documents modules that are explicitly referenced, even if they contain docstrings.A simple fix is to add the module to the API documentation
After rebuilding the docs, the API Reference should correctly include
get_fast_api_appand the rest of the module.Thank you.
olliefr commentedon Feb 19, 2026
@klateefa thank you for the tip but I don't think what you suggested is the right solution.
The reason this issue came to my attention is because I often interact with people who are new to ADK and the lack of easily accessible documentation for the
get_fast_api_appmethod often is an issue, because this method is shown in multiple code examples in ADK public documentation.Use of
get_fast_api_appmethod in code examples in project's official documentation makes it a public API method, so I think it's reasonable to expect it to be documented in the API reference.If
google.adk.cli.fast_apimodule containingget_fast_api_appmethod is private, then this method should not be used in code examples in the official documentation.Here's a quick list of pages from the official docs that make use of
get_fast_api_app:There is something very uncomfortable about integrating undocumented private module from a CLI tool into one's production container image build. The docs pages I referenced illustrate that there is a tangible need for a convenient method to configure the FastAPI application for ADK. If
get_fast_api_appis that method, it should have full documentation in the API Reference. If it is not the right method for the task, then the public documentation should stop promoting its use and it should use something more appropriate, instead.klateefa commentedon Feb 19, 2026
@olliefr Your point is valid using a function in official deployment guides (Cloud Run, GKE, Cloud Trace) implicitly makes it public API, so it should be documented as one.
The proper fix is
two-fold: export get_fast_api_appfromgoogle/adk/cli/__init__.py(addfrom .fast_api import get_fast_api_app) so it's a first-class public symbol, and add the.. automodule:: google.adk.cli.fast_apidirective to the adk-docs Sphinx config.Just patching the docs build without promoting it to the public namespace would be a half-measure given how prominently it's featured in production deployment examples.
Thank you.
olliefr commentedon Feb 19, 2026
@klateefa you are welcome! Is it OK if I submit a PR for this?
olliefr commentedon Feb 23, 2026
Two linked PRs are submitted to resolve this issue:
google.adk.cli.fast_api.get_fast_api_appto public namespace聽#4560 exports the right attribute.google.adk.cli.fast_api.get_fast_api_appto Python API Reference聽adk-docs#1335 updates the API Reference docs.@klateefa I could use some help with reviewing the PRs because I don't understand how the API Reference docs are built 馃檪
olliefr commentedon Feb 24, 2026
Update:
google/adk-docs#1335 is no longer required.
#4560 closes this issue.
olliefr commentedon Mar 16, 2026
Waiting on #4560...
docs: use sphinx-click to generate docs for google.adk.cli
docs: use sphinx-click to generate docs for google.adk.cli