Skip to content

Commit f85cc69

Browse files
committed
first version of the doc generated by copilot
1 parent c55c836 commit f85cc69

22 files changed

Lines changed: 6076 additions & 0 deletions

.github/workflows/deploy_docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: mkdocs-ci
2+
3+
on:
4+
push:
5+
branches:
6+
- feature/docs
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Set up Python
27+
uses: actions/setup-python@v5
28+
with:
29+
python-version: '3.10'
30+
cache: 'pip'
31+
32+
- name: Install dependencies
33+
run: |
34+
pip install --upgrade pip
35+
pip install mkdocs-material
36+
37+
- name: Build with MkDocs
38+
run: mkdocs build --strict
39+
40+
- name: Upload artifact
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: ./site
44+
45+
deploy:
46+
if: github.ref == 'refs/heads/feature/docs'
47+
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
runs-on: ubuntu-latest
52+
needs: build
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)