Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run docs test on azure pipelines #524

Merged
merged 1 commit into from
Aug 8, 2024
Merged

Run docs test on azure pipelines #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 0 additions & 37 deletions .github/workflows/docs-ci.yml
View file
Open in desktop

This file was deleted.

6 changes: 6 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions azure-pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion configure
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down