Skip to content

docs: add documentation #1

docs: add documentation

docs: add documentation #1

Workflow file for this run

name: Checks
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install dependencies
run: python3 -m pip install ".[dev]"
- name: Check style
run: python3 -m ruff check . && ruff format --check .
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11']
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: python3 -m pip install ".[test]"
- name: Run tests
env:
WAGSTAILS_TEST_ENV: true
run: python3 -m pytest tests/
docs:
runs-on: ubuntu-latest
env:
SPHINX_GITHUB_CHANGELOG_TOKEN: {{ "${{ secrets.SPHINX_GITHUB_CHANGELOG_TOKEN }}" }}

Check failure on line 42 in .github/workflows/checks.yaml

View workflow run for this annotation

GitHub Actions / Checks

Invalid workflow file

The workflow is not valid. .github/workflows/checks.yaml (Line: 42, Col: 38): A mapping was not expected
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install '.[docs]'
- name: Attempt docs build
working-directory: ./docs
run: make html