This documentation is written in Markdown.

Markdown files end in .md. You need a program to translate Markdown code into .html. The Makefile and build scripts are written to execute the Sphinx compiler, which is capable of translating .md files into a variety of target formats. It is also capable of extracting documentation from the source code of certain programming languages, and formatting that into target representation.

Sphinx installation documentation is available here.

Below are TLDR steps to build html pages locally.

Install Dependencies

git clone https://github.com/cmu-mfi/learninglab.git
cd ./learninglab
python -m venv ./.venv

# Linux/macOS Terminal
source .venv/bin/activate

# Windows CMD
call .venv\Scripts\activate.bat

pip install -U sphinx sphinx_rtd_theme myst_parser sphinx_copybutton

Build doc

cd learninglab

# Linux/macOS Terminal
source .venv/bin/activate

# Windows CMD
call .venv\Scripts\activate.bat

cd doc
make html

The HTML pages are in doc/_build/html.