geospatial-tools/Makefile.targets at eed5963a05cef7ded85a33dc1f523daa89e2ea62 · RolnickLab/geospatial-tools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# This file is for custom makefile targets at the project level.
# They are meant to be share by the whole project team.

## -- Project targets ----------------------------------------------------------------------------------------------- ##

.PHONY: test-notebooks
test-notebooks: ## Execute test notebooks using pytest and nbval
	$(ENV_COMMAND_TOOL) nox -s test_nb

## -- Docs targets -------------------------------------------------------------------------------------------------- ##
.PHONY: preview-docs
preview-docs: ## Preview the documentation site locally
	@poetry run mkdocs serve -a 0.0.0.0:7000


.PHONY: build-docs
build-docs: ## Build the documentation files locally
	@poetry run mkdocs build

.PHONY: deploy-docs
deploy-docs: ## Publish and deploy the documentation to the live Github page
	@echo""; \
	echo -e "\e[1;39;41m-- WARNING --\e[0m This command will deploy all current changes to the live Github page - Making it publicly available"; \
	echo""; \
	echo -n "Would you like to deploys the docs? [Y/n]: "; \
	read ans; \
	case $$ans in \
		[Yy]*) \
			echo""; \
			poetry run mkdocs gh-deploy; \
			echo""; \
			;; \
		*) \
			echo""; \
			echo "Skipping publication to Github Pages."; \
			echo " "; \
			;; \
	esac; \