History

Chi Wang 2d6c8c012b version update (#2908 ) * version update * version update		2024-06-10 18:23:51 +00:00
..
blog	version update (#2908 )	2024-06-10 18:23:51 +00:00
docs	version update (#2908 )	2024-06-10 18:23:51 +00:00
src	AutoGen Virtual Focus Group (#2598 )	2024-05-14 09:19:43 +00:00
static	Add Git LFS check action, fix broken lfs files (#2436 )	2024-04-18 16:50:15 +00:00
.gitignore	Update the auto_feedback_from_code_execution notebook to use code executor (#2366 )	2024-04-18 07:53:19 +00:00
README.md	add RAG under topics (#1990 )	2024-03-14 00:49:39 +00:00
babel.config.js	web-template	2023-08-27 21:30:54 -04:00
build_website.sh	Extend process_notebooks for testing (#1789 )	2024-02-29 20:47:30 +00:00
docusaurus.config.js	Autogenstudio docs (#2890 )	2024-06-10 03:29:34 +00:00
package.json	add clarity analytics (#2201 )	2024-03-28 23:26:22 +00:00
process_notebooks.py	Add isort (#2265 )	2024-04-05 02:26:06 +00:00
pydoc-markdown.yml	fix some docstring issues affecting rendering (#1739 )	2024-02-20 22:29:39 +00:00
sidebars.js	Autogenstudio docs (#2890 )	2024-06-10 03:29:34 +00:00
yarn.lock	add clarity analytics (#2201 )	2024-03-28 23:26:22 +00:00

README.md

Website

This website is built using Docusaurus 3, a modern static website generator.

Prerequisites

To build and test documentation locally, begin by downloading and installing Node.js, and then installing Yarn. On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:

npm install --global yarn

Installation

pip install pydoc-markdown pyyaml colored
cd website
yarn install

Install Quarto

quarto is used to render notebooks.

Install it here.

Note: Ensure that your quarto version is 1.5.23 or higher.

Local Development

Navigate to the website folder and run:

pydoc-markdown
python ./process_notebooks.py render
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.