Skip to content

Merge pull request #325 from vipyrsec/remove-email #535

Merge pull request #325 from vipyrsec/remove-email

Merge pull request #325 from vipyrsec/remove-email #535

Workflow file for this run

name: "GitHub Pages - Python Sphinx"
on:
push:
branches:
- main
pull_request:
env:
DRAGONFLY_GITHUB_TOKEN: "This is just here for autodoc"
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: "Checkout repository"
uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
- name: "Setup PDM"
uses: pdm-project/setup-pdm@568ddd69406b30de1774ec0044b73ae06e716aa4 # v4
with:
python-version: "3.12"
cache: true
- name: "Install dependencies"
run: pdm install --group docs
- name: "Build docs"
run: |
cd docs
pdm run make dirhtml
- name: "Upload artifact"
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
with:
path: ./docs/build/dirhtml
deploy:
if: ${{ github.ref == 'refs/heads/main' }}
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@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5