Merge pull request #319 from 8ear/8ear-add-mkdocs-documentation

Add `make deploy` to Makefile
pull/326/head
Alexandre Dulaunoy 3 years ago committed by GitHub
commit fdd845df34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 23
      Makefile

@ -1,3 +1,4 @@
# https://www.mkdocs.org/user-guide/deploying-your-docs/
.PHONY: prepare_docs generate_docs ci_generate_docs test_docs
@ -9,11 +10,25 @@ prepare_docs:
cp -R doc/logos/* docs/import_mod/logos
cp LICENSE docs/license.md
generate_docs: prepare_docs
docker run --rm -it -v $(PWD):/docs squidfunk/mkdocs-material build
install_requirements:
pip install -r docs/REQUIREMENTS.txt
ci_generate_docs: prepare_docs
generate_docs: prepare_docs
mkdocs build
deploy:
mkdocs gh-deploy
test_docs: prepare_docs
docker run --rm -it -p 8000:8000 -v $(PWD):/docs squidfunk/mkdocs-material
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

Loading…
Cancel
Save