Skip to content

Commit

Permalink
add the jp book deploy workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
robinzyb committed Oct 20, 2023
1 parent 0389025 commit dc3df96
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: deploy-book

# Only run this when the master branch changes
on:
push:
branches:
- main

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

# Install dependencies
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8

- name: Run image
uses: abatilo/actions-poetry@v2
with:
poetry-version: 1.4.2

- name: Install dependencies
run: |
poetry install
- name: Sphinx APIDoc
run: |
poetry run sphinx-apidoc -f -o jupyter-book/_api/ ai2_kit/ --separate
# Build the book
- name: Build the book
run: |
poetry run jupyter-book build jupyter-book/
# Push the book's HTML to github-pages
- name: GitHub Pages action
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: jupyter-book/_build/html

0 comments on commit dc3df96

Please sign in to comment.