Skip to content

Commit

Permalink
Added actions for auto doc deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
rzimmerdev committed Dec 1, 2024
1 parent 0342089 commit e0a61d9
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Deploy Sphinx Docs to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: [ "main" ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
# Build job
build:
runs-on: ubuntu-latest
container:
image: python:3.11

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

- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-book-theme sphinx-autodoc-typehints myst-parser sphinx_design
- name: Build Sphinx Documentation
run: |
cd docs
make html
- name: Upload Sphinx Build Artifact
if: ${{ env.SKIP_ARTIFACT_UPLOAD != 'true' }}
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build/html

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit e0a61d9

Please sign in to comment.