How to Update This Markdown Book

mdBook Documentation

Setup

If not already done, install mdbook

Serving locally

Run the following in the repository root directory:

1. If any python files were modified,
   1. Install pipx
   2. Install pydoc-markdown
   3. run pydoc-markdown -I python/ --render-toc > docs/src/python-doc.md. Do not modify this file manually.
2. Run mdbook serve --open docs/

Publishing

1. Update book.toml or files in docs/src/
2. Make sure the docs look good locally by running the steps in Serving Locally
3. Commit files and push to main branch

After that, a GitHub action will build the book and publish it.