Compartmentalize docs workflow #2
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: Deploy documentation | |
on: | |
push: | |
branches: [ master ] | |
pull_request: | |
branches: [ master ] | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
strategy: | |
max-parallel: 5 | |
steps: | |
- name: Checkout playzerx repo | |
uses: actions/checkout@v4 | |
- name: Set up Python 3.10 | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: Install Python dependencies | |
run: | | |
cd docs | |
pip install --upgrade pip | |
mkdir venv | |
python3 -m venv ./venv | |
ls venv/ | |
source ./venv/bin/activate | |
pip install -r requirements.txt | |
- name: Install system dependencies | |
run: | | |
sudo apt-get install doxygen graphviz -y | |
- name: Generate Doxygen collateral | |
run: | | |
cd docs | |
source ./venv/bin/activate | |
doxygen Doxyfile | |
- name: Generate Sphinx documentation | |
run: | | |
cd docs | |
source ./venv/bin/activate | |
make html | |
- name: Upload build artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: docs-artifact | |
path: docs/build/ |