Merge pull request #524 from nexB/update-ci

Run docs test on azure pipelines

Makefile

@@ -154,6 +154,12 @@ docs:
 	rm -rf docs/_build/
 	@${ACTIVATE} sphinx-build docs/source docs/_build/
 
+check_docs:
+	@echo "Check Sphinx Documentation build minimally"
+	@${ACTIVATE} sphinx-build -E -W docs/source build
+	@echo "Check for documentation style errors"
+	@${ACTIVATE} doc8 --max-line-length 100 docs/source --ignore D000 --quiet
+
 docker-images:
 	@echo "-> Build Docker services"
 	docker-compose build

azure-pipelines.yml

@@ -32,3 +32,11 @@ jobs:
           python_versions: ['3.10', '3.11', '3.12']
           test_suites:
               all: make test
+
+    - template: etc/ci/azure-posix.yml
+      parameters:
+          job_name: ci_documentation
+          image_name: ubuntu-22.04
+          python_versions: ['3.10']
+          test_suites:
+              all: make check_docs

configure

@@ -31,7 +31,7 @@ CUSTOM_PACKAGES=""
 
 # Requirement arguments passed to pip and used by default or with --dev.
 REQUIREMENTS="$CUSTOM_PACKAGES --editable purldb-toolkit/ --editable purl2vcs/ --editable . --constraint requirements.txt"
-DEV_REQUIREMENTS="$CUSTOM_PACKAGES --editable purldb-toolkit/[testing] --editable .[testing] --editable purl2vcs/[testing] --constraint requirements.txt --constraint requirements-dev.txt"
+DEV_REQUIREMENTS="$CUSTOM_PACKAGES --editable purldb-toolkit/[testing] --editable .[testing,docs] --editable purl2vcs/[testing] --constraint requirements.txt --constraint requirements-dev.txt"
 DOCS_REQUIREMENTS="$CUSTOM_PACKAGES --editable purldb-toolkit/ --editable .[docs] --constraint requirements.txt"
 
 # where we create a virtualenv