effde903c8
* add pydata theme dependencies add some organization of current files to filt #362 add reference remove jupyter-lite and jupyter-sphinx deps, update python docs to references/python refactor docs to fit new top level architecture of user guide, contribution, packages and references add sample switcher json add skeleton for version switcher add pointer to note on versioning Update python/packages/autogen-core/docs/src/_static/switcher.json Co-authored-by: Jack Gerrits <jackgerrits@users.noreply.github.com> Update python/packages/autogen-core/docs/src/_static/switcher.json Co-authored-by: Jack Gerrits <jackgerrits@users.noreply.github.com> remove unused components add privacy footer hide previous and next button remove 'Section Navigation' from sidebar make packages a single page general refactor, add missing items remove unneeded sidebar conf remove duplicate content on landing page update landing page text. general refactor, remove unreferences files, fix some build errors * remove extra files * move readme to correct location * remove sidebar from packages page, layout updates * update lock and add clean command * remove discord --------- Co-authored-by: Jack Gerrits <jack@jackgerrits.com> Co-authored-by: Jack Gerrits <jackgerrits@users.noreply.github.com>
1.7 KiB
Building the AGNext Documentation
AGNext 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.