json/doc/mkdocs/Makefile
Niels Lohmann 29cd970b94
Consolidate documentation (#3071)
* 🔥 consolidate documentation
* ♻️ overwork std specializations
* 🚚 move images files to mkdocs
* ♻️ fix URLs
* 🔧 tweak MkDocs configuration
* 🔧 add namespaces
* 📝 document deprecations
* 📝 document documentation generation
* 🚸 improve search
* 🚸 add examples
* 🚧 start adding documentation for macros
* 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139
* 📝 overwork example handling
* 📝 fix Markdown tables
2021-12-29 13:41:01 +01:00

34 lines
768 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
# create subfolders
mkdir docs/examples
# copy images
cp -vr ../json.gif docs/images
# copy examples
cp -vr ../examples/*.cpp ../examples/*.output docs/examples
# clean subfolders
clean:
rm -fr docs/images/json.gif 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 wheel
venv/bin/pip install -r requirements.txt
# uninstall the virtual environment
uninstall_venv: clean
rm -fr venv