Skip to content

Commit

Permalink
add ci job to build shpinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippvK committed Apr 26, 2024
1 parent a4df17a commit 996ebe5
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Build Documentation

on:
push:
branches:
- main
tags:
- 'v*'
pull_request:
branches:
- main
workflow_dispatch:

jobs:
docs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.10]
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Initialize Virtualenv
run: |
python -m pip install --upgrade pip virtualenv
python -m venv .venv
- name: Install dependencies
run: |
source .venv/bin/activate
pip install -r requirements.txt
pip install -r docs/requirements.txt
- name: Install package into virtualenv
run: |
source .venv/bin/activate
make install
- name: Build docs
run: |
source .venv/bin/activate
make docs
- name: Deploy docs
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html

0 comments on commit 996ebe5

Please sign in to comment.