Create a virtualenv e.g. cassio-website-3.10
pip install -r requirements.txt
Serve with:
mkdocs serve
Build with
mkdocs build
For cleanliness, please run this after closing the notebooks and before committing:
find -name "*.ipynb" | grep -v ".ipynb_checkpoints" | grep -v ".colab" | xargs ./nbUtils/notebook_cleaner.py
This simply strips stderr
noise (and possibly other stuff that gets in the way)
and cleans the cell numbering in the notebooks.
Run this after the above cleaning:
./nbUtils/notebook_colabifier.py
Do not push to main
. The main
branch should only receive merges from eng
.
Push to eng
directly only in quick-fix circumstances. Preferrably work on a feature branch and then submit a PR to eng
.