Skip to content

Deploy Documentation #633

Deploy Documentation

Deploy Documentation #633

Workflow file for this run

name: Deploy Documentation
on:
workflow_dispatch:
pull_request:
branches:
- release
jobs:
deploy-docs:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0}
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Set up Mamba
uses: conda-incubator/setup-miniconda@v2
with:
mamba-version: "*"
miniforge-variant: Mambaforge
allow-softlinks: true
use-only-tar-bz2: true
show-channel-urls: false
auto-activate-base: true
channel-priority: strict
python-version: 3.8
- name: Install dependencies
run: |
mamba install --file requirements/docs.txt
pip install -r requirements.txt
- name: Build the documentation
run: |
cd docs
make html
- name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
cname: openpnm.org