Skip to content

Commit

Permalink
add sphyinx workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
mccrindlebrian committed Dec 17, 2024
1 parent 0182026 commit 8d2346d
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/sphinx-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Build and Deploy Sphinx Documentation

on:
push:
branches:
- main # Trigger workflow on push to the main branch
- docs # Trigger workflow on push to the docs branch

jobs:
build:
name: Build Sphinx Documentation
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11' # Adjust the version to match your project

- name: Install Poetry
uses: abatilo/actions-poetry@v2
with:
poetry-version: "1.8.4" # Use the desired Poetry version

- name: Build HTML
run: |
cd docs/
make html
- name: Run ghp-import
run: |
ghp-import -n -p -f docs/_build/html

0 comments on commit 8d2346d

Please sign in to comment.