Skip to content

Commit dab188c

Browse files
committed
Move to mkdocs, begin reformatting
1 parent 71fc6db commit dab188c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1212
-5023
lines changed

.github/workflows/CI.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request: {}
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
with:
13+
fetch-depth: 0
14+
- name: "Set up Python"
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version-file: "pyproject.toml"
18+
- name: Install uv
19+
uses: astral-sh/setup-uv@v6
20+
- name: Install the project
21+
run: uv sync --locked --all-extras --dev
22+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
23+
- uses: actions/cache@v4
24+
with:
25+
key: mkdocs-material-${{ env.cache_id }}
26+
path: .cache
27+
restore-keys: |
28+
mkdocs-material-
29+
- name: Build docs
30+
env:
31+
CI: ${{ github.ref == 'refs/heads/main' }}
32+
run: uv run mkdocs build
33+
- name: Upload Pages artifact
34+
uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: site/
37+
deploy:
38+
if: github.ref == 'refs/heads/main'
39+
runs-on: ubuntu-latest
40+
needs: build
41+
permissions:
42+
pages: write # to deploy to Pages
43+
id-token: write # to verify the deployment originates from an appropriate source
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
steps:
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.cache
2+
.venv

TiLDA_MK3(1).md

Lines changed: 0 additions & 2 deletions
This file was deleted.

SiNE.md renamed to docs/SiNE.md

Lines changed: 2 additions & 6 deletions

0 commit comments

Comments
 (0)