feat: GitHub workflow for documentations

This commit is contained in:
Leni Aniva 2024-10-18 14:48:26 -07:00
parent d39f501d4b
commit 18872dc0ec
Signed by: aniva
GPG Key ID: 4D9B1C8D10EA4C50
2 changed files with 41 additions and 0 deletions

40
.github/workflows/docs.yaml vendored Normal file
View File

@ -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
.gitignore vendored
View File

@ -1,5 +1,6 @@
.* .*
!.gitignore !.gitignore
!.github
# Python # Python
*.py[cod] *.py[cod]