Skip to content

Merge pull request #24 from cedadev/dev #138

Merge pull request #24 from cedadev/dev

Merge pull request #24 from cedadev/dev #138

Workflow file for this run

name: Sphinx build
on:
# Push/Pull for main branch.
push:
branches: [main]
pull_request:
branches: [main]
# Run workflow manually from actions tab.
workflow_dispatch:
jobs:
build:
# Linux version requirements
runs-on: ubuntu-latest
steps:
# Checkout and build the docs with sphinx
- uses: actions/checkout@v2
- name: Set up Python 3.10
uses: actions/setup-python@v2
with:
python-version: "3.10"
- name: Build HTML
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
# pre-build-command: "mkdir /tmp/sphinx-log"
- name: Upload artifacts
uses: actions/upload-artifact@v1
with:
name: html-docs
path: docs/build/html/
# Deploys to the gh-pages branch if the commit was made to main, the
# gh-pages then takes over serving the html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html