Skip to content

Commit 3f7b8dd

Browse files
author
F.
committed
{feat) docs
1 parent 4d4fbac commit 3f7b8dd

File tree

6 files changed

+422
-12
lines changed

6 files changed

+422
-12
lines changed

.github/workflows/documentation.yml

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,12 @@ on:
88
paths:
99
- 'docs/**'
1010
- '.github/workflows/documentation.yml'
11-
- 'mkdocs.yml'
1211
pull_request:
1312
branches:
1413
- main
1514
paths:
1615
- 'docs/**'
1716
- '.github/workflows/documentation.yml'
18-
- 'mkdocs.yml'
1917

2018
permissions:
2119
contents: write
@@ -28,24 +26,28 @@ jobs:
2826
with:
2927
fetch-depth: 0
3028

31-
- uses: actions/setup-python@v4
29+
- name: Set up Python
30+
uses: actions/setup-python@v4
3231
with:
3332
python-version: '3.x'
34-
cache: pip
33+
cache: 'pip'
34+
cache-dependency-path: 'docs/requirements.txt'
3535

3636
- name: Install dependencies
37+
working-directory: docs
3738
run: |
38-
pip install mkdocs-material
39-
pip install mkdocs-git-revision-date-localized-plugin
40-
pip install mkdocs-minify-plugin
39+
python -m pip install --upgrade pip
40+
pip install -r requirements.txt
41+
42+
- name: Build Documentation
43+
working-directory: docs
44+
if: github.event_name == 'pull_request'
45+
run: mkdocs build
4146

4247
- name: Deploy Documentation
48+
working-directory: docs
4349
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
4450
run: |
4551
git config --global user.name "github-actions[bot]"
4652
git config --global user.email "github-actions[bot]@users.noreply.github.com"
4753
mkdocs gh-deploy --force
48-
49-
- name: Build Documentation
50-
if: github.event_name == 'pull_request'
51-
run: mkdocs build

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,3 +384,5 @@ $RECYCLE.BIN/
384384

385385
### Project Files ###
386386
*.prof
387+
# MkDocs generated files
388+
site/

.yamllint.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
extends: default
3+
rules:
4+
braces:
5+
max-spaces-inside: 1
6+
level: error
7+
brackets:
8+
max-spaces-inside: 1
9+
level: error
10+
line-length: disable
11+
truthy: disable
12+
ignore: |
13+
.golangci.yaml
14+
.trunk/*
15+
docs/mkdocs.yml

0 commit comments

Comments
 (0)