Skip to content

Documentation

Documentation #31

Workflow file for this run

name: Documentation
on:
push:
paths:
- "docs/**"
- "AUTHORS.rst"
- "CHANGES.rst"
- "CONTRIBUTING.rst"
- "LICENSE.rst"
- "README.rst"
pull_request:
paths:
- "docs/**"
- "AUTHORS.rst"
- "CHANGES.rst"
- "CONTRIBUTING.rst"
- "LICENSE.rst"
- "README.rst"
jobs:
build:
# We want to run on external PRs, but not on our own internal PRs as they'll be run
# by the push to the branch. Without this if check, checks are duplicated since
# internal PRs match both the push and pull_request events.
if:
github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
github.repository
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0}
steps:
- uses: actions/checkout@v4
- uses: conda-incubator/setup-miniconda@v3
with:
python-version: "3.11"
environment-file: environment.yml
mamba-version: "*"
channels: conda-forge,defaults
channel-priority: true
- name: Show conda installation info
run: |
mamba info
mamba list
- name: Install package
run: |
make install
- name: Build documentation
run: |
make docs