Skip to content

Merge pull request #98 from ESAOpenSR/codex/rebrand-docs-to-opensr-sr… #75

Merge pull request #98 from ESAOpenSR/codex/rebrand-docs-to-opensr-sr…

Merge pull request #98 from ESAOpenSR/codex/rebrand-docs-to-opensr-sr… #75

Workflow file for this run

name: Build Docs
on:
push:
branches:
- main
paths:
- "docs/**"
workflow_dispatch: # allow manual runs
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install doc dependencies
run: |
pip install --upgrade pip
pip install mkdocs-material mkdocstrings[python] pymdown-extensions
- name: Make repo importable
run: |
pip install -e . || true
- name: Build MkDocs site
run: |
PYTHONPATH=. mkdocs build
- uses: actions/upload-pages-artifact@v3
with:
path: ./site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4