VOL-4840 - docs.voltha.org edits
Makefile
patches/python_310_migration.sh
-------------------------------
o Change log message to note venv patching by version.
o Original message could be interpreted as explict patching of wrong version.
makefiles/lint/include.mk
-------------------------
o Document lint targets: usage, commands, makefiles, etc.
Change-Id: I895a0a032f856632c9adf31aa634b6cbf0328cdb
diff --git a/Makefile b/Makefile
index 289559c..908e7b2 100644
--- a/Makefile
+++ b/Makefile
@@ -78,7 +78,7 @@
ifndef NO_PATCH
@echo
@echo "========================================"
- @echo "Applying python 3.10.x migration patches"
+ @echo "Applying python virtualenv patches as needed (v3.10+)"
@echo "========================================"
./patches/python_310_migration.sh '--venv' "$@" 'apply'
endif
@@ -90,10 +90,12 @@
# lint and link verification. linkcheck is part of sphinx
test: lint linkcheck
+
# doctest
# coverage
# linkcheck
lint: doc8
+# include $(MAKEDIR)/lint/shell.mk
doc8: $(VENV_NAME) | $(OTHER_REPO_DOCS)
source $</bin/activate ; set -u ;\
@@ -189,6 +191,14 @@
source $</bin/activate ; set -u ;\
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
+BROWSER ?= $(error Usage: $(MAKE) $@ BROWSER=)
+view-html:
+ "$(BROWSER)" _build/html/index.html
+
+## -----------------------------------------------------------------------
+## -----------------------------------------------------------------------
include $(MAKEDIR)/help/trailer.mk
# [EOF]