Skip to content

No docs are generated for google.adk.cli module for Python API Reference #4500

@olliefr

Description

@olliefr

🔴 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:

Image Image

How often has this issue occurred?:

  • Always (100%)

Metadata

Metadata

Assignees

Labels

answered[Status] This issue has been answered by the maintainerdocumentation[Component] This issue is related to documentation, it will be transferred to adk-docs

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions