Merge pull request #124 from HiIAmTzeKean/license #71
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: Builds and deploys Python Sphinx documentation | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository content | |
uses: actions/checkout@v4 # Checkout the repository content to github runner. | |
- name: Install Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12.5 | |
- name: Setup Poetry | |
uses: pronovic/setup-poetry@v2 | |
with: | |
version: "1.8.0" | |
plugins: "poetry-dynamic-versioning==1.2.0" | |
cache-venv: "true" | |
cache-poetry: "true" | |
- name: Install dependencies | |
run: poetry install --with dev | |
shell: bash | |
- name: Build sphinx | |
run: poetry run sphinx-build -M html docs/source docs/build | |
shell: bash | |
- name: Deploy to external repos | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{secrets.GITHUB_TOKEN}} | |
publish_branch: gh-pages | |
publish_dir: docs/build/html/ |