📝 add mkdocs

This commit is contained in:
Niels Lohmann 2020-05-24 13:03:04 +02:00
parent c92a696852
commit a8f0cd15df
No known key found for this signature in database
GPG key ID: 7F3CEA63AE251B69
36 changed files with 2656 additions and 261 deletions

24
doc/mkdocs/Makefile Normal file
View file

@ -0,0 +1,24 @@
serve: prepare_files
venv/bin/mkdocs serve
prepare_files:
# build Doxygen
$(MAKE) -C ..
# clean subfolders
rm -fr docs/images docs/examples
# create subfolders
mkdir docs/images docs/examples
# copy images
cp -vr ../json.gif docs/images
# copy examples
cp -vr ../examples/*.cpp ../examples/*.output docs/examples
publish: prepare_files
venv/bin/mkdocs gh-deploy --clean --force
install_venv:
python3 -mvenv venv
venv/bin/pip install -r requirements.txt
uninstall_venv:
rm -fr venv