Skip to content

Fix github links, syntax warnings #222

Fix github links, syntax warnings

Fix github links, syntax warnings #222

name: Documentation
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout github repo
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Lint
uses: psf/black@stable
with:
version: "23.7.0"
- name: Install pandoc
uses: pandoc/actions/setup@main
- name: Upgrade pip, install package, install requirements, build docs
run: |
pip install --upgrade pip
pip install -r ./docs/requirements.txt
pip install sphinx
sphinx-build docs ./docs/_build/html/
- name: Checkout pages branch
uses: actions/checkout@v4
with:
ref: gh-pages
path: gh-pages
- name: Commit documentation changes
run: |
cp -r docs/_build/html/* gh-pages/
cd gh-pages
touch .nojekyll
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
git push