Skip to content

Commit

Permalink
Merge pull request #114 from IMMM-SFA/feature/auto-build-docs
Browse files Browse the repository at this point in the history
rename github actions, add auto-build docs github action
  • Loading branch information
erexer authored Jan 24, 2025
2 parents 6daf2ac + 3264e10 commit 20737cf
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: docs

on:
push:
branches: [ main ]

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Install pandoc
run: |
sudo apt-get update -y && sudo apt-get install -y pandoc
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.9'
- name: Update pip and install python dependencies
run: |
python -m pip install --upgrade pip
pip install .[docs]
- name: Build html docs
working-directory: 'docs/'
run: |
make html
- name: Commit documentation changes
run: |
cd docs/build/html
git init
git add -A
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git commit -m 'deploy' -a || true
- name: Push changes to gh-pages
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: docs/build/html
force: true
github_token: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit 20737cf

Please sign in to comment.