2019-08-02 10:28:08 +02:00
|
|
|
# https://www.mkdocs.org/user-guide/deploying-your-docs/
|
2019-07-31 08:25:51 +02:00
|
|
|
|
|
|
|
.PHONY: prepare_docs generate_docs ci_generate_docs test_docs
|
|
|
|
|
|
|
|
prepare_docs:
|
2021-04-19 10:22:10 +02:00
|
|
|
cd documentation; python3 generate_documentation.py
|
2019-07-31 08:25:51 +02:00
|
|
|
mkdir -p docs/expansion/logos docs/export_mod/logos docs/import_mod/logos
|
2021-04-19 10:27:45 +02:00
|
|
|
mkdir -p docs/logos
|
|
|
|
cd documentation; cp -R ./logos/* ../docs/logos
|
2021-04-19 10:22:10 +02:00
|
|
|
cd documentation; cp -R ./logos/* ../docs/expansion/logos
|
|
|
|
cd documentation; cp -R ./logos/* ../docs/export_mod/logos
|
|
|
|
cd documentation; cp -R ./logos/* ../docs/import_mod/logos
|
2021-04-19 10:27:45 +02:00
|
|
|
cp ./documentation/mkdocs/*.md ./docs
|
2021-04-19 11:05:22 +02:00
|
|
|
cp LICENSE ./docs/license.md
|
2019-07-31 08:25:51 +02:00
|
|
|
|
2019-08-02 10:28:08 +02:00
|
|
|
install_requirements:
|
|
|
|
pip install -r docs/REQUIREMENTS.txt
|
|
|
|
|
2019-07-31 08:25:51 +02:00
|
|
|
generate_docs: prepare_docs
|
2019-08-02 10:28:08 +02:00
|
|
|
mkdocs build
|
2019-07-31 08:25:51 +02:00
|
|
|
|
2019-08-02 09:02:32 +02:00
|
|
|
deploy:
|
2019-08-02 10:28:08 +02:00
|
|
|
mkdocs gh-deploy
|
2019-07-31 08:25:51 +02:00
|
|
|
|
|
|
|
test_docs: prepare_docs
|
2019-08-02 10:28:08 +02:00
|
|
|
mkdocs serve
|
|
|
|
|
|
|
|
|
|
|
|
# DOCKER make commands
|
|
|
|
generate_docs_docker: prepare_docs
|
|
|
|
docker run --rm -it -v $(PWD):/docs squidfunk/mkdocs-material build
|
|
|
|
|
|
|
|
deploy_docker:
|
|
|
|
docker run --rm -it -v $(PWD):/docs -v /home/$(whoami)/.docker:/root/.docker:ro squidfunk/mkdocs-material gh-deploy
|
|
|
|
|
|
|
|
test_docs_docker: prepare_docs
|
|
|
|
docker run --rm -it -p 8000:8000 -v $(PWD):/docs squidfunk/mkdocs-material
|