Skip to content

Commit

Permalink
feat: add docs action
Browse files Browse the repository at this point in the history
  • Loading branch information
willeccles committed Oct 18, 2024
1 parent a7c8209 commit 01666b5
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/release-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Publish Docs

on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+'

workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-24.04

steps:
- uses: actions/checkout@v4

- name: Setup venv
run: |
python -m venv .venv
. .venv/bin/activate
python -m pip install -r docs/doc-requirements.txt
- name: Run Sphinx
run: |
. .venv/bin/activate
python -m sphinx -an docs docs/_build
- name: Setup pages
uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/_build'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 01666b5

Please sign in to comment.