Skip to content

Commit e80b533

Browse files
committed
add docs publishing workflow
1 parent 656b518 commit e80b533

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed

.github/workflows/docs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: docs
2+
on:
3+
push:
4+
branches:
5+
- smithy-python-docs
6+
permissions:
7+
contents: write
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v5
13+
- name: Configure Git Credentials
14+
run: |
15+
git config user.name github-actions[bot]
16+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
17+
- uses: actions/setup-python@v6
18+
with:
19+
python-version: 3.12.x
20+
- name: Install uv
21+
uses: astral-sh/setup-uv@v6
22+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
23+
- uses: actions/cache@v4
24+
with:
25+
key: mkdocs-material-${{ env.cache_id }}
26+
path: .cache
27+
restore-keys: |
28+
mkdocs-material-
29+
- run: uv sync --group docs
30+
- run: uv run mkdocs gh-deploy --force

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ changelog = [
2626
]
2727
docs = [
2828
"mkdocs-material~=9.6.20",
29-
"mkdocstrings-python~=0.30.1"
29+
"mkdocstrings-python~=1.18.2"
3030
]
3131

3232
[tool.uv]

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)