ci: publish docs on push.

This commit is contained in:
2025-03-07 20:32:31 +08:00
parent b3b7d4fb84
commit 91bf6546da
2 changed files with 74 additions and 2 deletions

40
.github/workflows/docs.yaml vendored Normal file
View File

@@ -0,0 +1,40 @@
name: MkDocs
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Prepare Cache ID
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- name: Restore Cache
uses: actions/cache@v4
with:
key: mkdocs-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-
- name: Setup MkDocs
run: pip install -r requirements.txt
- name: Deploy MkDocs
run: mkdocs gh-deploy --force

View File

@@ -1,3 +1,35 @@
mkdocs-material==9.6.7
mkdocs-git-revision-date-localized-plugin==1.4.1
babel==2.17.0
backrefs==5.8
certifi==2025.1.31
charset-normalizer==3.4.1
click==8.1.8
colorama==0.4.6
ghp-import==2.1.0
gitdb==4.0.12
GitPython==3.1.44
idna==3.10
Jinja2==3.1.6
Markdown==3.7
MarkupSafe==3.0.2
mergedeep==1.3.4
mkdocs==1.6.1
mkdocs-get-deps==0.2.0
mkdocs-git-committers-plugin-2==2.5.0
mkdocs-git-revision-date-localized-plugin==1.4.1
mkdocs-material==9.6.7
mkdocs-material-extensions==1.3.1
packaging==24.2
paginate==0.5.7
pathspec==0.12.1
platformdirs==4.3.6
Pygments==2.19.1
pymdown-extensions==10.14.3
python-dateutil==2.9.0.post0
pytz==2025.1
PyYAML==6.0.2
pyyaml_env_tag==0.1
requests==2.32.3
six==1.17.0
smmap==5.0.2
urllib3==2.3.0
watchdog==6.0.0