Skip to content

Commit 7e707ef

Browse files
authored
Project setup (#1)
* Create Satzung.md * Init * Add GitHub Actions workflow for publishing docs * Add README with project setup and preview instructions Added project setup instructions and local preview command. * Create Satzung.md * Update test.yml
1 parent 6a1101a commit 7e707ef

11 files changed

Lines changed: 730 additions & 132 deletions

File tree

.devcontainer/devcontainer.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "Animexx Docs",
3+
"image": "python:3-slim-trixie",
4+
"customizations": {
5+
"vscode": {
6+
"extensions": [
7+
"charliermarsh.ruff"
8+
],
9+
"settings": {
10+
"editor.formatOnSave": true,
11+
"editor.codeActionsOnSave": {
12+
"source.organizeImports": "explicit"
13+
},
14+
"[python]": {
15+
"editor.defaultFormatter": "charliermarsh.ruff"
16+
}
17+
}
18+
}
19+
}
20+
}

.github/workflows/publish.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Publish
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
jobs:
16+
publish:
17+
environment:
18+
name: github-pages
19+
url: ${{ steps.deployment.outputs.page_url }}
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v5
23+
- uses: actions/setup-python@v6
24+
with:
25+
cache: "pip"
26+
- run: |
27+
pip install -r requirements-dev.txt
28+
mkdocs build
29+
- uses: actions/upload-pages-artifact@v4
30+
with:
31+
path: "./site"
32+
- uses: actions/deploy-pages@v4

.github/workflows/test.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Test
2+
3+
on:
4+
push:
5+
branches:
6+
- "**"
7+
8+
workflow_dispatch:
9+
10+
jobs:
11+
test:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v5
15+
- uses: actions/setup-python@v6
16+
with:
17+
cache: "pip"
18+
- run: |
19+
pip install -r requirements.txt
20+
mkdocs build

0 commit comments

Comments
 (0)