Add makefile targets for doc8 lint, fix formatting/spelling issues
Change-Id: I0f45ffe0ba94fab89f9b38c9b73ed7b9091f1795
diff --git a/Makefile b/Makefile
index 7d9dc5c..05ed311 100644
--- a/Makefile
+++ b/Makefile
@@ -90,11 +90,14 @@
docker-run-dev: # @HELP Runs the container locally (intended for development purposes, not in detached mode)
docker run ${DOCKER_PORTS} --privileged --rm --name bbsim ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}bbsim:${DOCKER_TAG} /app/bbsim ${DOCKER_RUN_ARGS}
-.PHONY: docs
+.PHONY: docs docs-lint
docs: swagger # @HELP Generate docs and opens them in the browser
- cd docs; make doc_venv; make html; cd -
+ make -C docs html
@echo -e "\nBBSim documentation generated in file://${PWD}/docs/build/html/index.html"
+docs-lint:
+ make -C docs lint
+
# Release related items
# Generates binaries in $RELEASE_DIR with name $RELEASE_NAME-$RELEASE_OS_ARCH
# Inspired by: https://github.com/kubernetes/minikube/releases