Skip to content

Commit 1cf7a1f

Browse files
committed
Add GitHub Actions workflow for docs deployment
1 parent d1372f6 commit 1cf7a1f

695 files changed

Lines changed: 22781 additions & 11881 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.DS_Store

8 KB
Binary file not shown.

.github/workflows/docs.yml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- docs
7+
pull_request:
8+
branches:
9+
- docs
10+
workflow_dispatch:
11+
12+
# Sets permissions for GitHub Pages deployment
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: false
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v4
29+
30+
- name: Setup Python
31+
uses: actions/setup-python@v5
32+
with:
33+
python-version: '3.12'
34+
35+
- name: Install uv
36+
run: |
37+
curl -LsSf https://astral.sh/uv/install.sh | sh
38+
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
39+
40+
- name: Create virtual environment
41+
run: uv venv
42+
43+
- name: Install docs dependencies
44+
run: |
45+
source .venv/bin/activate
46+
uv pip install --group docs
47+
48+
- name: Install editable client packages
49+
run: |
50+
source .venv/bin/activate
51+
uv pip install -e clients/aws-sdk-bedrock-runtime
52+
uv pip install -e clients/aws-sdk-transcribe-streaming
53+
54+
- name: Build documentation
55+
run: |
56+
source .venv/bin/activate
57+
mkdocs build -v
58+
59+
- name: Upload artifact
60+
uses: actions/upload-pages-artifact@v3
61+
with:
62+
path: ./site
63+
64+
deploy:
65+
# Only deploy on push to docs branch, not on PRs
66+
if: github.event_name == 'push' && github.ref == 'refs/heads/docs'
67+
environment:
68+
name: github-pages
69+
url: ${{ steps.deployment.outputs.page_url }}
70+
runs-on: ubuntu-latest
71+
needs: build
72+
steps:
73+
- name: Deploy to GitHub Pages
74+
id: deployment
75+
uses: actions/deploy-pages@v4

.idea/.gitignore

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/aws-sdk-python.iml

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/inspectionProfiles/Project_Default.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/inspectionProfiles/profiles_settings.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/misc.xml

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/.DS_Store

8 KB
Binary file not shown.

0 commit comments

Comments
 (0)