IREE User-Facing Documentation Website

This directory contains the source and assets for IREE's website, hosted on GitHub Pages.

The website is generated using MkDocs, with the Material for MkDocs theme.

How to edit this documentation

Follow https://squidfunk.github.io/mkdocs-material/getting-started/ and read https://www.mkdocs.org/.

All steps below are from this docs/website/ folder.

Setup (as needed):

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Develop:

./generate_extra_files.sh
mkdocs serve

Deploy:

• This force pushes to gh-pages on <your remote>. Please don't push to the main repository :)
• The publish_website.yml workflow takes care of publishing from the central repository automatically

mkdocs gh-deploy --remote-name <your remote>