Skip to content

Add ReadTheDocs

Add ReadTheDocs #68

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v3
- uses: mamba-org/setup-micromamba@v1
with:
environment-file: environment.yml
cache-environment: true
create-args: >-
python=3.10
- name: Deploy docs
shell: bash -l {0}
run: |
python -m ipykernel install --user --name=xhydro
pip install -e .
make -C docs html
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages # The branch the action should deploy to.
folder: docs/_build/html # The folder the action should deploy.