WIP: Update to automatically work with our current pyAFQ outputs #41
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: Documentation build | |
on: [push, pull_request] | |
permissions: | |
contents: write | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
strategy: | |
max-parallel: 4 | |
matrix: | |
python-version: ["3.10", "3.11"] | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v1 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v1 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install | |
run: | | |
python -m pip install --upgrade pip | |
pip install .[all] | |
sudo apt-get install -y xvfb | |
npm install -g jsdoc | |
- name: Build docs | |
env: | |
XVFB: 1 | |
DISPLAY: :99 | |
run: | | |
Xvfb :99 -screen 0 1280x1024x24 & | |
cd docs | |
make html | |
- name: Upload docs | |
uses: actions/upload-artifact@v1 | |
with: | |
name: docs | |
path: docs/_build/html | |
- name: Publish docs to Github Pages | |
if: startsWith(github.event.ref, 'refs/tags') | |
uses: JamesIves/github-pages-deploy-action@releases/v4 | |
with: | |
folder: docs/_build/html |