Skip to content

Commit d7aae55

Browse files
committed
Add generate docs action.
1 parent 04297cc commit d7aae55

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed

.github/workflows/generate-docs.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Generate Docs
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
build:
9+
runs-on: ${{ matrix.os }}
10+
11+
strategy:
12+
matrix:
13+
os: [ubuntu-latest, windows-latest, macos-latest]
14+
include:
15+
- os: ubuntu-latest
16+
platform: linux
17+
18+
- os: windows-latest
19+
platform: windows
20+
21+
- os: macos-latest
22+
platform: darwin
23+
24+
steps:
25+
- name: Checkout code.
26+
uses: actions/checkout@v4
27+
28+
- name: Setup up python.
29+
uses: actions/setup-python@v3
30+
with:
31+
python-version: "3.x"
32+
33+
- name: Install dependencies.
34+
run: |
35+
pip install -r requirements.txt
36+
37+
- name: Generate docs.
38+
run: |
39+
python -c "import sdl3"
40+
41+
- name: Upload asset.
42+
uses: actions/upload-release-asset@v1
43+
with:
44+
upload_url: ${{ github.event.release.upload_url }}
45+
asset_path: sdl3/__doc__.py
46+
asset_name: ${{ matrix.platform }}-docs.py
47+
asset_content_type: text/plain

.github/workflows/python-publish.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ jobs:
1212
runs-on: ubuntu-latest
1313

1414
steps:
15-
- uses: actions/checkout@v4
15+
- name: Checkout code.
16+
uses: actions/checkout@v4
1617

1718
- name: Set up Python.
1819
uses: actions/setup-python@v3

0 commit comments

Comments
 (0)