Skip to content

Commit

Permalink
Add a github action workflow to publish documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jaladh-singhal committed Mar 27, 2024
1 parent 58a96c7 commit f689329
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: "Publish documentation"
on:
push:
branches:
- master

workflow_dispatch: # Manual trigger

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: '3.10'
cache: 'pip'

- name: Create environment
run: |
pip install --upgrade pip
python -m venv .venv
source .venv/bin/activate

- name: Install dependencies
run: pip install -r requirements.txt

- name: Install package
run: pip install -e .

- name: Build docs
run: |
cd docs
make clean
make html

- name: Deploy docs
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html

0 comments on commit f689329

Please sign in to comment.