diff --git a/Makefile b/Makefile index d4554cc7..53839954 100644 --- 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 index 23faf951..3a108dbd 100644 --- a/azure-pipelines.yml +++ b/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 diff --git a/configure b/configure index 906137be..2ca14c39 100755 --- 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