Victor Dibia effde903c8
Transition to Pydata Sphinx Theme (#482)
* 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>
2024-09-17 09:22:38 -04:00
..
2024-08-29 17:21:53 -04:00
2024-08-19 20:32:34 +00:00
2024-08-29 17:58:00 -04:00

AutoGen Python packages

See autogen-core package for main functionality.

Development

TL;DR, run all checks with:

uv sync
source .venv/bin/activate
poe check

Setup

Virtual environment

To get a shell with the package available (virtual environment), in the current directory, run:

uv sync
source .venv/bin/activate

Common tasks

  • Format: poe format
  • Lint: poe lint
  • Test: poe test
  • Mypy: poe mypy
  • Pyright: poe pyright
  • Build docs: poe --directory ./packages/autogen-core/ docs-build
  • Auto rebuild+serve docs: poe --directory ./packages/autogen-core/ docs-serve

Note

These need to be run in the virtual environment.

Create new package

To create a new package, run:

uv sync
source .venv/bin/activate
cookiecutter ./templates/new-package/