Skip to content

Commit

Permalink
Add CI workflow to build the docs
Browse files Browse the repository at this point in the history
Builds on any push event temporarily
  • Loading branch information
rafmudaf committed Dec 26, 2024
1 parent 2d06deb commit 2765938
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/deploy-pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: deploy-pages

on:
push:
# branches:
# - develop
# paths:
# - docs/**

# This job installs dependencies, builds the book, and pushes it to `gh-pages`
jobs:
deploy-book:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

# Install dependencies
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Install dependencies
run: |
pip install -e ".[docs]"
# Build the book
- name: Build the book
working-directory: ${{runner.workspace}}/ard/docs/
run: |
jupyter-book build .
# Push the book's HTML to github-pages
- name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html

0 comments on commit 2765938

Please sign in to comment.