Skip to content

Commit

Permalink
ci: add workflow to generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin-Frost committed May 19, 2024
1 parent c142281 commit 26193b5
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/generate-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Generate HTML documentation

on:
push:
branches: ['main']

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install Python
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install dependencies
run: python -m pip install -U md2html-phuker

- name: Generate HTML documentation
run: md2html DOCS.md

- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: docs
path: DOCS.html
3 changes: 3 additions & 0 deletions DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Session 4 API Documentation

This is the API documentation for the AEC 2024 Skill 08 Session 4 API.

0 comments on commit 26193b5

Please sign in to comment.