8efe0c45b0
* Add tiktoken as a dependency in pyproject.toml Signed-off-by: Johan Forngren <johan.forngren@decerno.se> Update uv.lock with tiktoken dependency from fbfdc9f652384b70f7461c90ada13f87e83677e0 Signed-off-by: Johan Forngren <johan.forngren@decerno.se> * Updating autogen-ext dependencies per https://github.com/microsoft/autogen/pull/5008#issuecomment-2585383877 Signed-off-by: Johan Forngren <johan.forngren@decerno.se> * PoC dev container Signed-off-by: Johan Forngren <johan.forngren@decerno.se> * Enhance devcontainer setup with post-create script for dependency installation and improved performance. Removed partial hot reload setup, as it required bigger changes to the project. Improved documentation, and fixed markdown lint issues. Signed-off-by: Johan Forngren <johan.forngren@decerno.se> * Update installation documentation for AutoGen Studio, clarifying installation methods and improving formatting. Adjusted notes for Windows users and corrected minor grammatical issues. Signed-off-by: Johan Forngren <johan.forngren@decerno.se> * Fixing typos. Restructuring text to avoid consecutive markdown quote blocks separated only by a blank line to avoid MD028 - Blank line inside blockquote. Signed-off-by: Johan Forngren <johan.forngren@decerno.se> * Include dev containers tutorial Signed-off-by: Johan Forngren <johan.forngren@decerno.se> * Update dev container installation instructions Signed-off-by: Johan Forngren <johan.forngren@decerno.se> --------- Signed-off-by: Johan Forngren <johan.forngren@decerno.se> Co-authored-by: Victor Dibia <victordibia@microsoft.com>
Building the AutoGen Documentation
AutoGen documentation is based on the sphinx documentation system and uses the myst-parser to render markdown files. It uses the pydata-sphinx-theme to style the documentation.
Prerequisites
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:
uv sync
source .venv/bin/activate
Building Docs
To build the documentation, run the following command from the root of the python repository:
poe --directory ./packages/autogen-core/ docs-build
To serve the documentation locally, run the following command from the root of the python repository:
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 delete the ./packages/autogen-core/docs/build directory before running the docs-build command.
Versioning the Documentation
The current theme - pydata-sphinx-theme - supports switching between versions 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.