Skip to content

[minor] Compress documentation config a tad #16

[minor] Compress documentation config a tad

[minor] Compress documentation config a tad #16

Workflow file for this run

name: Documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
defaults:
run:
# See https://github.com/mamba-org/provision-with-micromamba#important
shell: bash -l {0}
jobs:
docs:
name: "GitHub Pages"
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: "Checkout Git repository"
uses: actions/checkout@v3
- name: "Install Conda environment with Micromamba"
uses: mamba-org/provision-with-micromamba@main
with:
cache-downloads: true
cache-env: true
environment-file: docs/environment.yml
environment-name: loop-rate-limiters
- name: "Build documentation"
run: |
sphinx-build docs _build -W
- name: "Deploy to GitHub Pages"
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true