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

Add CI job for testing django-setup-configuration docs #1377

Merged
merged 2 commits into from
Sep 5, 2024
Merged

Add CI job for testing django-setup-configuration docs #1377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
007b19c
Add CI job for testing django-setup-configuration docs
pi-sigma Aug 29, 2024
8032bf5
Update setup_config docs
pi-sigma Aug 29, 2024
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
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,9 @@ jobs:
DB_PASSWORD: ''
E2E_DRIVER: ${{ matrix.browser }}

#
# Docs
#
docs:
name: Build and check documentation
runs-on: ubuntu-latest
Expand All @@ -203,6 +206,26 @@ jobs:
export OPENSSL_CONF=$(pwd)/openssl.conf
pytest check_sphinx.py -v --tb=auto
working-directory: docs

setup-config-docs:
name: Check that documentation for configuration steps is up-to-date
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
submodules: 'true'
- name: Set up backend environment
uses: maykinmedia/setup-django-backend@v1
with:
apt-packages: 'libxml2-dev libxmlsec1-dev libxmlsec1-openssl gettext libgdal-dev gdal-bin graphviz'
python-version: '3.11'
setup-node: 'no'

- name: Build docs for django-setup-configuration steps
run: |
python src/manage.py generate_config_docs --dry-run

#
# Docker
#
Expand Down
Loading
Loading