1# serve the site locally 2serve: prepare_files style_check 3 venv/bin/mkdocs serve 4 5serve_dirty: prepare_files style_check 6 venv/bin/mkdocs serve --dirtyreload 7 8build: prepare_files style_check 9 venv/bin/mkdocs build 10 11# create files that are not versioned inside the mkdocs folder (images, examples) 12prepare_files: clean 13 mkdir docs/examples 14 cp -r ../json.gif docs/images 15 cp -r ../examples/*.cpp ../examples/*.output docs/examples 16 17style_check: 18 @cd docs ; python3 ../scripts/check_structure.py 19 20# clean subfolders 21clean: 22 rm -fr docs/images/json.gif docs/examples 23 24# publish site to GitHub pages 25publish: prepare_files 26 venv/bin/mkdocs gh-deploy --clean --force 27 28# install a Python virtual environment 29install_venv: requirements.txt 30 python3 -mvenv venv 31 venv/bin/pip install --upgrade pip 32 venv/bin/pip install wheel 33 venv/bin/pip install -r requirements.txt 34 35# uninstall the virtual environment 36uninstall_venv: clean 37 rm -fr venv 38
