Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,39 @@ name: Documentation

on:
push:
branches: [ "develop" ]
tags: [ "*" ]
branches: ["develop"]
tags: ["*"]
pull_request:
branches: [ "develop" ]
branches: ["develop"]

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: NiklasRosenstein/slap@gha/install/v1
- run: slap install --only-extras docs --no-venv-check
- run: slap run --no-venv-check docs:build
- uses: actions/upload-artifact@v4
with:
name: docs
path: docs/_site
- uses: actions/checkout@v4
- uses: NiklasRosenstein/slap@gha/install/v1
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.25"
- run: slap run --no-venv-check docs:build
- uses: actions/upload-artifact@v4
with:
name: docs
path: docs/_site

docs-publish:
needs: [ docs ]
needs: [docs]
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/develop'
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with: { name: docs, path: docs/site }
- uses: JamesIves/github-pages-deploy-action@v4.7.2
with: { branch: gh-pages, folder: docs/site, ssh-key: "${{ secrets.DEPLOY_KEY }}" }
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with: { name: docs, path: docs/site }
- uses: JamesIves/github-pages-deploy-action@v4.7.2
with:
{
branch: gh-pages,
folder: docs/site,
ssh-key: "${{ secrets.DEPLOY_KEY }}",
}
104 changes: 79 additions & 25 deletions .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ name: Python

on:
push:
branches: [ "develop" ]
tags: [ "*" ]
branches: ["develop"]
tags: ["*"]
pull_request:
branches: [ "develop" ]
branches: ["develop"]

jobs:
test:
Expand All @@ -15,26 +15,80 @@ jobs:
matrix:
# Generated with scripts/github_actions_get_python_versions.py
python-version: [
# NOTE: We do not check 3.8.0 because Flake8 does not run on it.
"3.8.1", "3.8.2", "3.8.3", "3.8.4", "3.8.5", "3.8.6", "3.8.7", "3.8.8", "3.8.9", "3.8.10", "3.8.11",
"3.8.12", "3.8.13", "3.8.14", "3.8.15", "3.8.16", "3.8.17", "3.8.18",
"3.9.0", "3.9.1", "3.9.2", "3.9.3", "3.9.4", "3.9.5", "3.9.6", "3.9.7", "3.9.8", "3.9.9", "3.9.10", "3.9.11",
"3.9.12", "3.9.13", "3.9.14", "3.9.15", "3.9.16", "3.9.17", "3.9.18",
"3.10.0", "3.10.1", "3.10.2", "3.10.3", "3.10.4", "3.10.5", "3.10.6", "3.10.7", "3.10.8", "3.10.9", "3.10.10",
"3.10.11", "3.10.12", "3.10.13",
"3.11.0", "3.11.1", "3.11.2", "3.11.3", "3.11.4", "3.11.5", "3.11.6", "3.11.7", "3.11.8",
"3.12.0", "3.12.1", "3.12.2",
"3.x", "pypy-3.8", # "pypy-3.9", "pypy-3.10"
]
# NOTE: We do not check 3.8.0 because Flake8 does not run on it.
"3.8.1",
"3.8.2",
"3.8.3",
"3.8.4",
"3.8.5",
"3.8.6",
"3.8.7",
"3.8.8",
"3.8.9",
"3.8.10",
"3.8.11",
"3.8.12",
"3.8.13",
"3.8.14",
"3.8.15",
"3.8.16",
"3.8.17",
"3.8.18",
"3.9.0",
"3.9.1",
"3.9.2",
"3.9.3",
"3.9.4",
"3.9.5",
"3.9.6",
"3.9.7",
"3.9.8",
"3.9.9",
"3.9.10",
"3.9.11",
"3.9.12",
"3.9.13",
"3.9.14",
"3.9.15",
"3.9.16",
"3.9.17",
"3.9.18",
"3.10.0",
"3.10.1",
"3.10.2",
"3.10.3",
"3.10.4",
"3.10.5",
"3.10.6",
"3.10.7",
"3.10.8",
"3.10.9",
"3.10.10",
"3.10.11",
"3.10.12",
"3.10.13",
"3.11.0",
"3.11.1",
"3.11.2",
"3.11.3",
"3.11.4",
"3.11.5",
"3.11.6",
"3.11.7",
"3.11.8",
"3.12.0",
"3.12.1",
"3.12.2",
"3.x",
"pypy-3.8", # "pypy-3.9", "pypy-3.10"
]
steps:
- uses: actions/checkout@v4
- uses: NiklasRosenstein/slap@gha/install/v1
- uses: actions/setup-python@v5
with: { python-version: "${{ matrix.python-version }}" }
- run: slap install --link --no-venv-check

# NOTE(@niklas): Flake8 doesn't run on 3.12 yet, so we only run pytest here.
- run: slap test
if: ${{ !startsWith(matrix.python-version, '3.12.') && matrix.python-version != '3.x' }}
- run: slap test pytest
if: ${{ startsWith(matrix.python-version, '3.12.') || matrix.python-version == '3.x' }}
- uses: actions/checkout@v4
- uses: NiklasRosenstein/slap@gha/install/v1
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.25"
- uses: actions/setup-python@v5
with: { python-version: "${{ matrix.python-version }}" }
- run: slap test
5 changes: 2 additions & 3 deletions docs/mksync-hook.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@

import os
from pathlib import Path
import subprocess as sp
from mkdocs.structure.pages import Page

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.pages import Page
from mksync import mksync_file


Expand Down
12 changes: 12 additions & 0 deletions docs/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[project]
name = "docs"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.13"
dependencies = [
"mkdocs>=1.6.1",
"mkdocs-material>=9.5.50",
"mkdocstrings[python]>=0.27.0",
"mksync>=0.1.4",
]
Loading
Loading