Skip to content

Merge branch 'dev' of https://github.com/PMEAL/porespy into dev #306

Merge branch 'dev' of https://github.com/PMEAL/porespy into dev

Merge branch 'dev' of https://github.com/PMEAL/porespy into dev #306

Workflow file for this run

name: Deploy Documentation
on:
workflow_dispatch:
push:
branches:
- dev
jobs:
deploy-docs:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0}
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Cache pip
uses: actions/cache@v2
with:
# This path is specific to Ubuntu
path: ~/.cache/pip
# Look to see if there is a cache hit for the corresponding requirements file
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
${{ runner.os }}-
- name: Install dependencies (conda)
run: |
pip install -r requirements.txt
pip install -r requirements/docs.txt
# Build the documentation
- name: Build the documentation
run: |
cd docs
make html
# Push the documentation's HTML to github-pages
- name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
cname: porespy.org