Skip to content

Commit

Permalink
CI - docs build & deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
ADBond committed Jan 7, 2025
1 parent 9a35263 commit 8332867
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Build and deploy documentation site
on:
push:
branches:
- main

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

- name: Setup uv
id: setup-uv
uses: astral-sh/setup-uv@v2
with:
# leave cache off until i figure out groups
enable-cache: false

- name: Setup Pages
id: pages
uses: actions/configure-pages@v5

- name: Install Python 3.12.8
run: uv python install 3.12.8

- name: Install dependencies, with docs dependencies
run: uv sync --group docs

- name: Build site with mkdocs
run: uv run mkdocs build

- name: Upload artifact
uses: actions/upload-pages-artifact@v3

deploy-site:
needs: build-site
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{steps.deployment.outputs.page_url}}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ dist/

tmp*

site/

*.html

*.csv
Expand Down

0 comments on commit 8332867

Please sign in to comment.