Skip to content

changelog for #336

changelog for #336 #26

Workflow file for this run

name: Docs
on:
push:
paths: ['docs/**', '.github/workflows/docs.yml', 'CHANGELOG.rst']
pull_request:
paths: ['docs/**', '.github/workflows/docs.yml', 'CHANGELOG.rst']
permissions:
contents: read
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: pip install -r docs/requirements.txt
- name: Build docs
run: |
cd docs
sphinx-build -b html -n -W --keep-going -j auto . _build
- name: Upload docs
uses: easingthemes/ssh-deploy@main
env:
SSH_PRIVATE_KEY: ${{ secrets.DOCS_KEY }}
ARGS: '-rzvc'
SOURCE: 'docs/_build/'
REMOTE_HOST: ${{ secrets.DOCS_HOST }}
REMOTE_USER: ${{ secrets.DOCS_USER }}
TARGET: '_build/docs/'
SCRIPT_BEFORE: mkdir -p _build
SCRIPT_AFTER: ./initdocs.sh && echo $RSYNC_STDOUT