Skip to content

Commit

Permalink
DOC: deploy documentation using Github Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dnicolodi committed Nov 7, 2023
1 parent 5285d4a commit 9d587b2
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ name: docs

on:
push:
tags:
- '[0-9]+.[0-9]+.[0-9]+'
pull_request:
branches:
- main
Expand All @@ -14,14 +16,37 @@ on:
- docs/**
- CHANGELOG.rst
- README.md
workflow_dispatch:
inputs:
tag:
required: true

jobs:
docs:

build:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- run: echo ${{ github.event.push.tag || github.event.inputs.tag }}
- uses: actions/checkout@v3
with:
ref: ${{ github.event.push.tag || github.event.inputs.tag }}
- run: python -m pip install .[docs]
- run: python -m sphinx docs/ build/docs/
- uses: actions/upload-pages-artifact@v1
with:
path: build/docs/html

deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
runs-on: ubuntu-latest
if: ${{ github.event.push.tag || github.event.inputs.tag }}
steps:
- uses: actions/deploy-pages@v1

0 comments on commit 9d587b2

Please sign in to comment.