Skip to content

Commit c7f38b5

Browse files
authored
move docs out of README (#173)
1 parent 964d49e commit c7f38b5

File tree

16 files changed

+565
-336
lines changed

16 files changed

+565
-336
lines changed

.github/dependabot.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ updates:
1111
directory: "/"
1212
schedule:
1313
interval: "weekly"
14+
1415
- package-ecosystem: "docker"
1516
directory: "/"
1617
schedule:

.github/workflows/docs.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Publish Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v5
13+
14+
- name: Setup Python
15+
uses: actions/setup-python@v6
16+
with:
17+
python-version: "3.x"
18+
19+
- name: Upgrade pip
20+
run: |
21+
# install pip=>20.1 to use "pip cache dir"
22+
python3 -m pip install --upgrade pip
23+
24+
- name: Get pip cache dir
25+
id: pip-cache
26+
run: echo "::set-output name=dir::$(pip cache dir)"
27+
28+
- name: Cache dependencies
29+
uses: actions/cache@v4
30+
with:
31+
path: ${{ steps.pip-cache.outputs.dir }}
32+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-docs.txt') }}
33+
restore-keys: |
34+
${{ runner.os }}-pip-
35+
36+
- name: Install dependencies
37+
run: python3 -m pip install -r ./requirements-docs.txt
38+
39+
- run: mkdocs build
40+
41+
- name: Deploy
42+
uses: peaceiris/actions-gh-pages@v4
43+
with:
44+
github_token: ${{ secrets.GITHUB_TOKEN }}
45+
publish_dir: ./site

0 commit comments

Comments
 (0)