Skip to content

Update requirements.txt #26

Update requirements.txt

Update requirements.txt #26

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write # Ensure the GITHUB_TOKEN has write access
# Skip docs if 'skip docs' is contained in the latest commit message
if: "!contains(github.event.head_commit.message, 'skip docs')"
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12.5
uses: actions/setup-python@v5
with:
python-version: "3.12.5"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install sphinx-rtd-theme
pip install -e ".[docs]"
- name: Build documentation
run: |
cd docs
make clean
make html
echo "" > _build/html/.nojekyll
- name: Commit documentation changes to gh-pages
run: |
git clone https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} --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 diff --quiet && git diff --staged --quiet || git commit -m "Upload documentation from latest commit"
- name: Push changes to gh-pages
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: "gh-pages"
directory: "gh-pages"