跳到主要内容

文档

如何在网站上获取渲染的笔记本

查看这里了解如何让notebook目录中的笔记本在网站上渲染的说明。

本地构建文档

1. 要在本地构建和测试文档,首先安装 Node.js。例如,

nvm install --lts

然后,安装 yarn 和其他所需的包:

npm install --global yarn
pip install pydoc-markdown pyyaml termcolor

2. 你还需要安装 quarto。请点击这个网站上的Pre-release标签,下载最新版本的quarto并安装。确保quarto的版本是1.5.23或更高。

3. 最后,运行以下命令进行构建:

cd website
yarn install --frozen-lockfile --ignore-engines
pydoc-markdown
python process_notebooks.py render
yarn start

最后一条命令启动了一个本地开发服务器并打开了一个浏览器窗口。 大多数更改无需重新启动服务器即可实时反映。

使用Docker构建

要在Docker容器中构建和测试文档,请使用dev文件夹中的Dockerfile,如上所述来构建你的镜像:

docker build -f .devcontainer/dev/Dockerfile -t autogen_dev_img https://github.com/microsoft/autogen.git#main

然后像这样启动容器,这将登录并确保Docker端口3000映射到本地机器的端口8081

docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogen_dev_img bash

在Docker的CLI中运行以下命令:

cd website
yarn install --frozen-lockfile --ignore-engines
pydoc-markdown
python process_notebooks.py render
yarn start --host 0.0.0.0 --port 3000

完成后,您应该能够通过 http://127.0.0.1:8081/autogen 访问文档。