mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
91c5414836
* added poe setup and docs * smaller bandit exclude * updated poe * updated naming * added something in samples * exclude docs from bandit * updated readme * removed ds_store * updated readme
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
## Building the Agent Framework Documentation
|
|
|
|
Agent Framework documentation is based on the sphinx documentation system and uses the myst-parser to render markdown files. It uses the [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/en/latest/) to style the documentation.
|
|
|
|
### Prerequisites
|
|
|
|
Ensure you have all of the dev dependencies for the `agent-framework` package installed. You can install them by running the following command from the root of the `python` directory:
|
|
|
|
```bash
|
|
uv sync
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
## Building Docs
|
|
|
|
To build the documentation, run the following command from the root of the python repository:
|
|
|
|
```bash
|
|
poe docs-build
|
|
```
|
|
|
|
To serve the documentation locally, run the following command from the root of the python repository:
|
|
|
|
```bash
|
|
poe --directory ./packages/autogen-core/ docs-serve
|
|
```
|
|
|
|
[!NOTE]
|
|
Sphinx will only rebuild files that have changed since the last build. If you want to force a full rebuild, you can run `poe docs-clean` before running the `docs-build` command.
|
|
|
|
## Versioning the Documentation
|
|
|
|
The current theme - [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/en/latest/) - supports [switching between versions](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html) of the documentation.
|
|
|
|
To version the documentation, you need to create a new version of the documentation by copying the existing documentation to a new directory with the version number. For example, to create a new version of the documentation for version `0.1.0`, you would run the following command:
|
|
|
|
How are various versions built? - TBD. |