Add documentation badge to README #6
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: Build 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: Setup Conda | |
uses: conda-incubator/setup-miniconda@v3 | |
with: | |
python-version: '3.11' | |
activate-environment: docs-env | |
auto-activate-base: false | |
- name: Install Python dependencies | |
shell: bash -l {0} | |
run: | | |
cd docs | |
pip install --upgrade pip | |
conda install pip | |
pip install -r requirements.txt | |
- name: Install system dependencies | |
run: | | |
sudo apt-get install doxygen graphviz -y | |
- name: Install fonts | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y fonts-roboto | |
- name: Generate Doxygen collateral | |
shell: bash -l {0} | |
run: | | |
cd docs | |
doxygen Doxyfile | |
- name: Generate Sphinx documentation | |
shell: bash -l {0} | |
run: | | |
cd docs | |
make html | |
- name: Upload build artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: docs-artifact | |
path: docs/_build/html/ |