Run docs test on azure pipelines

Signed-off-by: Jono Yang <[email protected]>
aboutcode-org · Aug 8, 2024 · 5b86bb2 · 5b86bb2
1 parent eb6c708
commit 5b86bb2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -154,6 +154,10 @@ docs:
 	rm -rf docs/_build/
 	@${ACTIVATE} sphinx-build docs/source docs/_build/
 
+check_docs:
+	@${ACTIVATE} sphinx-build -E -W docs/source build
+	@${ACTIVATE} docs/scripts/doc8_style_check.sh
+
 docker-images:
 	@echo "-> Build Docker services"
 	docker-compose build

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -31,4 +31,5 @@ jobs:
           image_name: ubuntu-22.04
           python_versions: ['3.10', '3.11', '3.12']
           test_suites:
+              docs: make check_docs
               all: make test
diff --git a/configure b/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