Merge pull request #2 from BenjaminDannegard/benjamindannegard/api-documentation

Adding API documentation for the WiFiS3 library

Author: BenjaminDannegard

.github/workflows/render-documentation.yml

@@ -0,0 +1,29 @@
+name: Render Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/render-documentation.ya?ml"
+      - "./libraries/WiFiS3/examples/**"
+      - "./libraries/WiFiS3/src/**"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/render-documentation.ya?ml"
+      - "./libraries/WiFiS3/examples/**"
+      - "./libraries/WiFiS3/src/**"
+  workflow_dispatch:
+      
+jobs:
+  render-docs:
+    permissions:
+      contents: write
+    uses: arduino/render-docs-github-action/.github/workflows/render-docs.yml@main
+    with:
+      source-path: './libraries/WiFiS3/src'
+      target-path: './libraries/WiFiS3/docs/api.md'
+      exclude-pattern: 'StringHelpers.h WiFi.h Modem.h'
+      commit: ${{ github.event_name != 'pull_request' }} # Only commit changes if not a PR

.gitignore

@@ -9,3 +9,4 @@ cores/arduino/mydebug.cpp.donotuse
 .DS_Store?
 /.vs
 /.gitignore
+.vscode/settings.json