Skip to content

update getting started #132

update getting started

update getting started #132

# This is a basic workflow to help you get started with Actions
name: Sphinx CD
# Controls when the workflow will run
on:
# Triggers the workflow on push events but only for the "master" branch
push:
branches:
- master
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
contents: write
# 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-and-deploy:
# 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
# Runs a set of commands using the runners shell
- name: directly build sphinx
run: |
cd docs
pip install -r requirements.txt
sphinx-build --version
sphinx-build -b html source build
cp source/images/interactive-plotly-visualization.html build/
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/build/ # The folder the action should deploy.