Skip to content

Commit

Permalink
docs: pyapi docs on github pages
Browse files Browse the repository at this point in the history
resolves #59
  • Loading branch information
chrjabs committed Mar 28, 2024
1 parent 8a11594 commit a13e9a8
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: GitHub Pages

on:
push:
tags:
- 'rustsat-v*'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Build Python package
uses: PyO3/maturin-action@v1
with:
args: -i python --manifest-path rustsat/Cargo.toml
- name: Install Python package
run: pip install target/wheels/rustsat*.whl
- name: Build Python API docs
run: pip install pdoc && pdoc -o _site/pyapi/ rustsat
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit a13e9a8

Please sign in to comment.