- Clone this repository and
cdinto the repository directory - Run
pip install -r requirements-docs.txt - Run
mkdocs serve, edit.mdfiles, and live preview - Contribute docs changes as usual
- The A2A docs use mkdocs and the mkdocs-material theme
- All of the source documentation / Markdown files related to the A2A docs are
in the
docs/directory in the A2A repository mkdocs.ymlin the repository root contains all of the docs config, including the site navigation and organization- There is a GitHub Action in
.github/workflows/docs.ymlthat builds and publishes the docs and pushes the built assets to thegh-pagesbranch in this repository usingmkdocs gh-deploy --force. This happens automatically for all commits / merges tomain. - The A2A documentation is hosted in GitHub pages, and the settings for this are in the A2A repository settings in GitHub.
The Python SDK documentation is built using Sphinx.
Ensure you have installed the documentation dependencies:
pip install -r ../../requirements-docs.txt-
Run the following command to build the HTML documentation:
sphinx-build -b html docs/sdk/python docs/sdk/python/api
-
The generated HTML files will be in the
sdk/python/apidirectory. You can opensdk/python/api/index.htmlin your browser to view the documentation.