Expanding documentation #4
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 and Deploy Sphinx Documentation | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
branches: | |
- master | |
permissions: | |
contents: write # Grants write access to the repository contents | |
jobs: | |
build: | |
name: Build and Deploy Sphinx Documentation | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout Repository | |
uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.13.1 | |
- name: Install Dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install sphinx-rtd-theme \ | |
sphinxcontrib-tikz \ | |
pydata-sphinx-theme \ | |
sphinx_design \ | |
sphinx_subfigure \ | |
myst_parser | |
- name: Build Documentation | |
run: | | |
cd docs | |
make html | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/build/html |