Documentation: Overview methods, ESN modules, & API overhaul #3
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build Documentation | |
on: | |
pull_request: | |
branches: | |
- "*" | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Cache conda | |
uses: actions/cache@v2 | |
env: | |
CACHE_NUMBER: 0 | |
with: | |
path: ~/conda_pkgs_dir | |
key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('docs/environment.yaml') }} | |
- uses: conda-incubator/setup-miniconda@v2 | |
with: | |
activate-environment: xesn | |
auto-update-conda: false | |
python-version: 3.11 | |
environment-file: docs/environment.yaml | |
use-only-tar-bz2: true # IMPORTANT: This needs to be set for caching to work properly! | |
- uses: ammaraskar/sphinx-action@master | |
with: | |
docs-folder: "docs/" |