feat: change actions for make docs with mkdocs (#12)

hadenlabs · Jan 22, 2021 · 5dadde6 · 5dadde6
1 parent 34ead3d
commit 5dadde6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 10 deletions.
diff --git a/provision/make/docs.mk b/provision/make/docs.mk
@@ -1,17 +1,15 @@
 #
-# See ./CONTRIBUTING.rst
+# See ./docs/contributing.md
 #
 
-FILE_README=$(ROOT_DIR)/README.md
-
 docs:
 	make docs.help
 
 docs.help:
 	@echo '    Docs:'
 	@echo ''
-	@echo '        docs.show                  Show restview README'
-	@echo '        docs.make                  Make documentation html'
+	@echo '        docs.show                  Show mkdocs'
+	@echo '        docs.build                 build mkdocs'
 	@echo '        docs.terraform             generated docs for terraform'
 	@echo ''
 
@@ -21,7 +19,8 @@ docs.terraform:
 			variables.tf)
 
 docs.show:
-	$(PIPENV_RUN) restview ${FILE_README}
+	$(PIPENV_RUN) mkdocs serve
+
+docs.build:
+	$(PIPENV_RUN) mkdocs build
 
-docs.make:
-	$(docker-compose) -f ${PATH_DOCKER_COMPOSE}/dev.yml run --rm docs bash -c "cd docs && make html"
diff --git a/provision/make/utils.mk b/provision/make/utils.mk
@@ -1,5 +1,5 @@
 #
-# See ./CONTRIBUTING.rst
+# See ./docs/contributing.md
 #
 .PHONY: utils.help
 

diff --git a/provision/make/yarn.mk b/provision/make/yarn.mk
@@ -1,5 +1,5 @@
 #
-# See ./CONTRIBUTING.rst
+# See ./docs/contributing.md
 #
 yarn.help:
 	@echo '    yarn:'