Skip to content

Commit 26193b5

Browse files
ci: add workflow to generate docs
1 parent c142281 commit 26193b5

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

.github/workflows/generate-docs.yaml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Generate HTML documentation
2+
3+
on:
4+
push:
5+
branches: ['main']
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v4
14+
15+
- name: Install Python
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: '3.10'
19+
20+
- name: Install dependencies
21+
run: python -m pip install -U md2html-phuker
22+
23+
- name: Generate HTML documentation
24+
run: md2html DOCS.md
25+
26+
- name: Upload artifact
27+
uses: actions/upload-artifact@v4
28+
with:
29+
name: docs
30+
path: DOCS.html

DOCS.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Session 4 API Documentation
2+
3+
This is the API documentation for the AEC 2024 Skill 08 Session 4 API.

0 commit comments

Comments
 (0)