diff --git a/Makefile b/Makefile index 06d28fd..1cff13f 100644 --- a/Makefile +++ b/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,15 +10,25 @@ prepare_docs: cp -R doc/logos/* docs/import_mod/logos cp LICENSE docs/license.md +install_requirements: + pip install -r docs/REQUIREMENTS.txt + generate_docs: prepare_docs - docker run --rm -it -v $(PWD):/docs squidfunk/mkdocs-material build - -# https://www.mkdocs.org/user-guide/deploying-your-docs/ -deploy: - docker run --rm -it -v $(PWD):/docs -v /home/$(whoami)/.docker:/root/.docker:ro squidfunk/mkdocs-material gh-deploy - -ci_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 \ No newline at end of file + 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