Merge pull request #134 from Computer-Aided-Validation-Laboratory/dev #24
This file contains hidden or 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 Sphinx Documentation | |
on: | |
push: | |
branches: ["main"] | |
workflow_dispatch: | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.11' | |
- name: Install Pyvale | |
run: | | |
python -m pip install --upgrade pip | |
pip install -e . | |
- name: Install documentation dependencies | |
run: | | |
pip install -r docs/requirements.txt | |
- name: Setup Doxygen | |
run: | | |
sudo apt update | |
sudo apt install -y doxygen | |
cd docs/source | |
doxygen Doxyfile | |
- name: Build documentation | |
run: | | |
cd docs | |
bash apidoc.sh | |
make html | |
- name: Setup Pages | |
uses: actions/configure-pages@v4 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: 'docs/build/html' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |