Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 48 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Check Docs Build

# Builds the documentation on pull requests so broken mkdocstrings
# references, dead nav links, and other docs errors are caught before
# merge instead of during a release deploy.

on:
pull_request:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'src/**'
- 'terratorch_iterate/**'
- '.github/workflows/docs-check.yml'
workflow_dispatch:

permissions:
contents: read

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: pip

- name: Install doc dependencies
run: |
pip install \
mkdocs-material \
mkdocstrings[python] \
mkdocs-git-revision-date-localized-plugin \
griffe

- name: Install claimed package (for mkdocstrings introspection)
run: pip install -e .

- name: Build docs (strict)
run: mkdocs build --strict
4 changes: 3 additions & 1 deletion .github/workflows/publish-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,6 @@ jobs:
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: |
python -m twine check dist/*
python -m twine upload dist/* --non-interactive
# --skip-existing so re-triggered tag pushes (e.g. moving a tag to
# pick up a docs fix) don't fail when the version is already on PyPI.
python -m twine upload dist/* --non-interactive --skip-existing
39 changes: 0 additions & 39 deletions .github/workflows/python-publish.yml

This file was deleted.

Loading