update the "Reading and plotting manually" portion of docs #832
Workflow file for this run
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: docs build | |
on: | |
push: | |
branches: | |
- main | |
pull_request: | |
branches: | |
- main | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Install pandoc and doxygen | |
run: | | |
sudo apt install pandoc doxygen | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
cache: "pip" | |
- name: Install dependencies | |
run: pip install -r ./requirements.txt | |
- name: Install pyro | |
run: pip install . | |
- name: Build docs | |
run: | | |
cd docs/ | |
PYTHONPATH=$GITHUB_WORKSPACE make SPHINXOPTS=-v html | |
- name: Check links | |
run: | | |
cd docs/ | |
PYTHONPATH=$GITHUB_WORKSPACE make SPHINXOPTS=-v linkcheck | |