Skip to content

Commit 29a2c9d

Browse files
gigapodgigapod
committed
moved doxygen support into place, added workflows for builds - nothing tested yet
1 parent 3d943a7 commit 29a2c9d

File tree

8 files changed

+3143
-0
lines changed

8 files changed

+3143
-0
lines changed

‎.github/workflows/build-deploy-ghpages.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Build Documentation and Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
id-token: write
12+
pages: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: true
17+
18+
jobs:
19+
# Build job
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
# Checkout the repository
24+
- name: Checkout repository
25+
uses: actions/checkout@v2
26+
with:
27+
fetch-depth: 0
28+
submodules: "true"
29+
30+
- name: Set Version
31+
run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./docs/doxygen/doxygen-config
32+
33+
- name: Build Documentation
34+
uses: mattnotmitt/doxygen-action@v1.9.5
35+
with:
36+
doxyfile-path: "./docs/doxygen/doxygen-config"
37+
38+
# Upload the documentation as an artifact
39+
- name: Upload documentation
40+
uses: actions/upload-pages-artifact@v3.0.1
41+
with:
42+
path: ./docs/html
43+
44+
# Deploy job
45+
deploy:
46+
# Add a dependency to the build job
47+
needs: build
48+
49+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
50+
permissions:
51+
pages: write # to deploy to Pages
52+
id-token: write # to verify the deployment originates from an appropriate source
53+
54+
# Deploy to the github-pages environment
55+
environment:
56+
name: github-pages
57+
url: ${{ steps.deployment.outputs.page_url }}
58+
59+
# Specify runner + deployment step
60+
runs-on: ubuntu-latest
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
id: deployment
64+
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

‎.github/workflows/compile-sketch.yml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
name: Cross-compilation test
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
10+
jobs:
11+
compile-sketch:
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
fail-fast: false
16+
17+
matrix:
18+
board:
19+
# # Uno
20+
# # https://github.com/arduino/ArduinoCore-avr/blob/master/boards.txt
21+
# - fqbn: arduino:avr:mega
22+
# # platforms: |
23+
# name: arduino:avr
24+
# source-url: https://downloads.arduino.cc/packages/package_index.json
25+
26+
# ESP32
27+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
28+
- fqbn: esp32:esp32:esp32
29+
# platforms: |
30+
name: esp32:esp32
31+
source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
32+
33+
# ESP32-S2
34+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
35+
- fqbn: esp32:esp32:esp32s2
36+
# platforms: |
37+
name: esp32:esp32
38+
source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
39+
40+
# ESP32-C3
41+
# https://github.com/espressif/arduino-esp32/blob/master/boards.txt
42+
- fqbn: esp32:esp32:esp32s3
43+
# platforms: |
44+
name: esp32:esp32
45+
source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
46+
47+
# SAMD21
48+
# https://github.com/arduino/ArduinoCore-samd/blob/master/boards.txt
49+
- fqbn: arduino:samd:mkr1000
50+
# platforms: |
51+
name: arduino:samd
52+
source-url: https://downloads.arduino.cc/packages/package_index.json
53+
54+
# Nano BLE 33 / nRF52840
55+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
56+
- fqbn: arduino:mbed:nano33ble
57+
# platforms: |
58+
name: arduino:mbed
59+
source-url: https://downloads.arduino.cc/packages/package_index.json
60+
61+
# # RP2040
62+
# # https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
63+
# - fqbn: rp2040:rp2040:sparkfun_promicrorp2040
64+
# # platforms: |
65+
# name: rp2040:rp2040
66+
# source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
67+
68+
# # RP2350
69+
# # https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
70+
# - fqbn: rp2040:rp2040:sparkfun_promicrorp2350
71+
# # platforms: |
72+
# name: rp2040:rp2040
73+
# source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
74+
75+
# STM32
76+
# https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt
77+
# - fqbn: STMicroelectronics:stm32:GenF4
78+
# # platforms: |
79+
# name: STMicroelectronics:stm32
80+
# source-url: https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
81+
82+
steps:
83+
- name: Checkout
84+
uses: actions/checkout@v3
85+
86+
- name: Branch name
87+
run: echo running on branch ${GITHUB_REF##*/}
88+
89+
# Setup Arduino command line - install esp32 and all the libs flux needs
90+
- name: Arduino - Install and setup the Arduino CLI
91+
uses: arduino/setup-arduino-cli@v2
92+
93+
- name: Arduino - Start config file
94+
run: arduino-cli config init --additional-urls ${{ matrix.board.source-url}}
95+
96+
- name: Arduino - Update index
97+
run: arduino-cli core update-index
98+
99+
- name: Arduino - Install platform
100+
run: arduino-cli core install ${{ matrix.board.name}}
101+
102+
- name: Arduino - Install libraries
103+
run: |
104+
arduino-cli config set library.enable_unsafe_install true
105+
arduino-cli version
106+
arduino-cli lib install 'SparkFun Toolkit'
107+
108+
- name: Compile Sketch
109+
run: arduino-cli compile --fqbn ${{ matrix.board.fqbn }} examples/Example01_BasicReadings --library .
110+
111+
# outputs:
112+
# report-artifact-name: ${{ steps.report-artifact-name.outputs.report-artifact-name }}
113+

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/doxygen/doxygen-awesome-css"]
2+
path = docs/doxygen/doxygen-awesome-css
3+
url = https://github.com/jothepro/doxygen-awesome-css.git

‎docs/doxygen/doxygen-awesome-css

Submodule doxygen-awesome-css added at 568f56c

0 commit comments

Comments
 (0)