feat: GitHub workflow for documentations
This commit is contained in:
parent
d39f501d4b
commit
18872dc0ec
|
@ -0,0 +1,40 @@
|
||||||
|
name: deploy-docs
|
||||||
|
|
||||||
|
# Run this when the master or main branch changes
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- docs/main
|
||||||
|
|
||||||
|
# This job installs dependencies, builds the book, and pushes it to `gh-pages`
|
||||||
|
jobs:
|
||||||
|
deploy-book:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
pages: write
|
||||||
|
id-token: write
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
- name: Set up Python 3.11
|
||||||
|
uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: 3.11
|
||||||
|
|
||||||
|
# Build the book
|
||||||
|
- name: Build the book
|
||||||
|
run: |
|
||||||
|
jupyter-book build docs
|
||||||
|
|
||||||
|
# Upload the book's HTML as an artifact
|
||||||
|
- name: Upload artifact
|
||||||
|
uses: actions/upload-pages-artifact@v2
|
||||||
|
with:
|
||||||
|
path: "docs/_build/html"
|
||||||
|
|
||||||
|
# Deploy the book's HTML to GitHub Pages
|
||||||
|
- name: Deploy to GitHub Pages
|
||||||
|
id: deployment
|
||||||
|
uses: actions/deploy-pages@v2
|
|
@ -1,5 +1,6 @@
|
||||||
.*
|
.*
|
||||||
!.gitignore
|
!.gitignore
|
||||||
|
!.github
|
||||||
|
|
||||||
# Python
|
# Python
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
|
|
Loading…
Reference in New Issue