forked from Research/WhisperCom
35 lines
900 B
Makefile
35 lines
900 B
Makefile
|
# serve the site locally
|
||
|
|
serve: prepare_files
|
||
|
|
venv/bin/mkdocs serve
|
||
|
|
|
||
|
|
build: prepare_files
|
||
|
|
venv/bin/mkdocs build
|
||
|
|
|
||
|
|
# create files that are not versioned inside the mkdocs folder
|
||
|
|
prepare_files: clean
|
||
|
|
# build Doxygen
|
||
|
|
$(MAKE) -C ..
|
||
|
|
# create subfolders
|
||
|
|
mkdir docs/images docs/examples
|
||
|
|
# copy images
|
||
|
|
cp -vr ../json.gif ../images/range-begin-end.svg ../images/range-rbegin-rend.svg ../images/callback_events.png ../images/json_syntax_number.png docs/images
|
||
|
|
# copy examples
|
||
|
|
cp -vr ../examples/*.cpp ../examples/*.output docs/examples
|
||
|
|
|
||
|
|
# clean subfolders
|
||
|
|
clean:
|
||
|
|
rm -fr docs/images docs/examples
|
||
|
|
|
||
|
|
# publish site to GitHub pages
|
||
|
|
publish: prepare_files
|
||
|
|
venv/bin/mkdocs gh-deploy --clean --force
|
||
|
|
|
||
|
|
# install a Python virtual environment
|
||
|
|
install_venv: requirements.txt
|
||
|
|
python3 -mvenv venv
|
||
|
|
venv/bin/pip install -r requirements.txt
|
||
|
|
|
||
|
|
# uninstall the virtual environment
|
||
|
|
uninstall_venv: clean
|
||
|
|
rm -fr venv
|