Skip to content

Better installation instructions #82

Better installation instructions

Better installation instructions #82

Workflow file for this run

name: docs
on:
push:
branches: ["master"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme h5py h5writer numpy pexpect pint PyQt5 pyqtgraph pytz pyzmq scipy tornado
- name: Sphinx build
run: |
sphinx-build docs _build
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload _build/
path: '_build/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4