diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml deleted file mode 100644 index 94862f68..00000000 --- a/.github/workflows/docs-ci.yml +++ /dev/null @@ -1,37 +0,0 @@ -name: CI Documentation - -on: [push, pull_request] - -jobs: - build: - runs-on: ubuntu-22.04 - - strategy: - max-parallel: 4 - matrix: - python-version: ["3.10"] - - steps: - - name: Checkout code - uses: actions/checkout@v3 - - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 - with: - python-version: ${{ matrix.python-version }} - - - name: Install Dependencies - working-directory: . - run: ./configure --docs - - - name: Check Sphinx Documentation build minimally - working-directory: ./docs - run: | - source ../venv/bin/activate - sphinx-build -E -W source build - - - name: Check for documentation style errors - working-directory: ./docs - run: | - source ../venv/bin/activate - ./scripts/doc8_style_check.sh diff --git a/Makefile b/Makefile index d4554cc7..8aa2aec5 100644 --- a/Makefile +++ b/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 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