chore: add docs requirements to make dev (#64)

awslabs · Jun 15, 2021 · f892dc0 · f892dc0
1 parent 83788fe
commit f892dc0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -2,10 +2,13 @@ CFN_LINT = cfn-lint-serverless
 TFLINT = tflint-ruleset-aws-serverless
 EXAMPLES = examples
 
-dev:
+dev: requirements-dev
 	$(MAKE) -C $(CFN_LINT) dev
 	$(MAKE) -C $(TFLINT) dev
 
+dev-requirements:
+	pip install -r requirements-dev.txt
+
 pr:
 	$(MAKE) -C $(CFN_LINT) pr
 	$(MAKE) -C $(TFLINT) pr
@@ -14,6 +17,9 @@ test:
 	$(MAKE) -C $(CFN_LINT) test
 	$(MAKE) -C $(TFLINT) test
 
+docs-serve:
+	mkdocs serve
+
 release-check:
 	grep "version = \"$$RELEASE_TAG_VERSION\"" cfn-lint-serverless/pyproject.toml
 	grep "Version: \"$$RELEASE_TAG_VERSION\"" tflint-ruleset-aws-serverless/main.go

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,2 @@
+mkdocs
+mkdocs-material