Introduce Sphinx for documentation #5
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: Build Documentation | |
on: [push, pull_request] | |
jobs: | |
sphinx: | |
runs-on: ubuntu-22.04 | |
steps: | |
- name: Checkout code including full history and submodules | |
uses: actions/checkout@v3 | |
with: | |
submodules: true | |
fetch-depth: 0 | |
- name: Install dependencies from APT repository | |
run: | | |
sudo apt-get update | |
sudo apt-get install cmake ninja-build | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r doc/sphinx/requirements.txt | |
- name: Build Sphinx documentation | |
run: | | |
sphinx-build -M html sphinx sphinx_output | |
working-directory: doc/ | |
- name: Upload HTML documentation | |
uses: actions/upload-artifact@v1 | |
with: | |
name: Documentation (HTML) | |
path: doc/sphinx_output/html |