Skip to content

Merge pull request #135 from geotribu/dependabot/pip/requirements/sph… #60

Merge pull request #135 from geotribu/dependabot/pip/requirements/sph…

Merge pull request #135 from geotribu/dependabot/pip/requirements/sph… #60

Workflow file for this run

name: "📚 Documentation"
on:
push:
branches: [main]
paths:
- ".github/workflows/documentation.yml"
- "docs/**/*"
- "qtribu/**/*.py"
- "qtribu/metadata.txt"
- "requirements/documentation.txt"
tags:
- "*"
env:
PYTHON_VERSION: 3.9
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Get source code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
cache: "pip"
cache-dependency-path: "requirements/documentation.txt"
python-version: ${{ env.PYTHON_VERSION }}
- name: Cache Sphinx cache
uses: actions/cache@v3
with:
path: docs/_build/cache
key: ${{ runner.os }}-sphinx-${{ hashFiles('docs/**/*') }}
restore-keys: |
${{ runner.os }}-sphinx-
- name: Install project requirements
run: |
python -m pip install -U pip setuptools wheel
python -m pip install -U -r requirements/documentation.txt
- name: Build doc using Sphinx
run: sphinx-build -b html -d docs/_build/cache -j auto -q docs docs/_build/html
- name: Deploy to GitHub Pages
run: |
python -m pip install -U ghp-import
ghp-import --force --no-history --no-jekyll --push docs/_build/html