You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 992 B

1234567891011121314151617181920212223242526272829
  1. ## Building the AutoGen Documentation
  2. AutoGen 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.
  3. ### Prerequisites
  4. Ensure you have all of the dev dependencies for the `autogen-core` package installed. You can install them by running the following command from the root of the python repository:
  5. ```bash
  6. uv sync
  7. source .venv/bin/activate
  8. ```
  9. ## Building Docs
  10. To build the documentation, run the following command from the root of the python directory:
  11. ```bash
  12. poe docs-build
  13. ```
  14. To serve the documentation locally, run the following command from the root of the python directory:
  15. ```bash
  16. poe docs-serve
  17. ```
  18. [!NOTE]
  19. Sphinx will only rebuild files that have changed since the last build. If you want to force a full rebuild, you can delete the `./docs/build` directory before running the `docs-build` command.