Update Dashboard Sink Documentation #53
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Test Sphinx HTML compile | |
# Runs on pushes to pull request | |
on: pull_request | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
id-token: write | |
jobs: | |
# Build job | |
build: | |
name: Test Compile Sphinx HTML | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout Repository | |
uses: actions/checkout@v4 | |
with: | |
submodules: 'true' | |
- name: Install Sphinx and Graphviz | |
run: | | |
sudo apt-get update | |
sudo apt install -y python3-sphinx-rtd-theme graphviz | |
- name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v5 | |
- name: Build with sphinx | |
run: make html SPHINXOPTS="-W" | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: ./_build/html |