History

Jack Gerrits 97923eeed8 Split apart ecosystem page, update sidebar, other website tweaks (#1812 ) * Split apart ecosystem page, update sidebar * fix docs 404 * fix redirect and link --------- Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>		2024-03-02 06:24:56 +00:00
..
blog	Blog regarding finite-state machine (#1622 )	2024-02-26 18:10:00 +00:00
docs	Split apart ecosystem page, update sidebar, other website tweaks (#1812 )	2024-03-02 06:24:56 +00:00
src	Add function generator and validator to gallery (#1807 )	2024-02-29 15:48:10 +00:00
static	Add function generator and validator to gallery (#1807 )	2024-02-29 15:48:10 +00:00
.gitignore	Rewrite and consolidate configuration docs (#1581 )	2024-02-11 18:04:43 +00:00
README.md	Extend process_notebooks for testing (#1789 )	2024-02-29 20:47:30 +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	Split apart ecosystem page, update sidebar, other website tweaks (#1812 )	2024-03-02 06:24:56 +00:00
package.json	Rewrite and consolidate configuration docs (#1581 )	2024-02-11 18:04:43 +00:00
process_notebooks.py	Extend process_notebooks for testing (#1789 )	2024-02-29 20:47:30 +00:00
pydoc-markdown.yml	fix some docstring issues affecting rendering (#1739 )	2024-02-20 22:29:39 +00:00
sidebars.js	Split apart ecosystem page, update sidebar, other website tweaks (#1812 )	2024-03-02 06:24:56 +00:00
yarn.lock	Rewrite and consolidate configuration docs (#1581 )	2024-02-11 18:04:43 +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: Support for Docusaurus 3.0 in Quarto is from version 1.4. Ensure that your quarto version is 1.4 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.