Skip to content

Merge pull request #114 from kristinlam/main #5

Merge pull request #114 from kristinlam/main

Merge pull request #114 from kristinlam/main #5

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: Sphinx Documentation for LabGraph
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the main branch
push:
branches: [ main ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3
- name: Build Sphinx
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "sphinx/"
pre-build-command: "pip install --upgrade myst-parser"
build-command: "sphinx-build . _build"
- name: Where we at
run: pwd && ls /home/runner/work/labgraph/labgraph/sphinx/_build/
- name: Deploy to GitHub pages
uses: JamesIves/github-pages-deploy-action@4.1.1
with:
branch: gh-pages
folder: "/home/runner/work/labgraph/labgraph/sphinx/_build/"