Documentation: Add initial docs setup #3
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 Sphinx Documentation | |
on: | |
push: | |
paths: | |
- "docs/**" # Only trigger when files in docs folder change | |
branches: | |
- "**" | |
pull_request: | |
paths: | |
- "docs/**" # Only trigger when files in docs folder change | |
branches: | |
- "**" | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.x" | |
cache: "pip" | |
- name: Install dependencies | |
working-directory: ./docs | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements.txt | |
- name: Build Documentation | |
working-directory: ./docs | |
run: | | |
make html | |
- name: Upload documentation artifacts | |
uses: actions/upload-artifact@v4 | |
with: | |
name: sphinx-docs | |
path: docs/_build/html/ # Updated path to reflect docs directory | |
retention-days: 7 |