Skip to content

Commit

Permalink
Create docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
rhoadesScholar authored Jul 24, 2024
1 parent 18a415e commit 9c3750a
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Deploy Sphinx Docs to GitHub Pages

on:
push:
branches:
- main # or your default branch

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx
- name: Build documentation
# run: make -C docs html # Adjust the path to your docs directory if needed
run: sh docs/build_docs.sh

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html

0 comments on commit 9c3750a

Please sign in to comment.