Skip to content

Commit

Permalink
add workflow to update website
Browse files Browse the repository at this point in the history
  • Loading branch information
degleris1 committed Nov 25, 2024
1 parent 6c372c8 commit 3a3bf11
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# name: "Sphinx: Render docs"

name: documentation

on: push

permissions:
contents: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Setup Poetry
run: snok/install-poetry@v1
- name: Install Dependencies
run: poetry install --with=docs --without=experiment

- name: Sphinx build
run: poetry run sphinx-build docs/source _site

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true

0 comments on commit 3a3bf11

Please sign in to comment.