name: Docs
on:
push:
branches: [main]
workflow_dispatch:
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@v5
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cache Cargo registry and build
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-docs-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-docs-
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.12"
- name: Cache astro-data
id: cache-astro-data
uses: actions/cache@v4
with:
path: astro-data
key: astro-data-v1
- name: Install system dependencies for cartopy
run: sudo apt-get update && sudo apt-get install -y libgeos-dev libproj-dev proj-data
- name: Install satkit
run: pip install -e .
- name: Install docs dependencies
run: pip install -r docs/requirements.txt
- name: Generate static plots
env:
SATKIT_DATA: astro-data
run: python docs/examples/gen_plots.py
- name: Build docs
env:
SATKIT_DATA: astro-data
run: mkdocs build
- name: Upload pages artifact
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:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4