Skip to content

Merge pull request #19 from greglucas/major-updates #8

Merge pull request #19 from greglucas/major-updates

Merge pull request #19 from greglucas/major-updates #8

Workflow file for this run

name: Publish Documentation
on:
push:
branches:
- main
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install packages
run: |
pip install .[doc]
- name: Build documentation
run: |
cd docs
make html
- uses: actions/upload-artifact@v4
with:
name: DocumentationHTML
path: docs/build/html/
# Publish built docs to gh-pages branch
- name: Commit documentation changes
run: |
git clone https://github.com/greglucas/pysecs.git --branch gh-pages --single-branch gh-pages
cp -r docs/build/html/* gh-pages/
cd gh-pages
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore that.
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}