Compare commits
32 commits
delete_unu
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
139855f5a6 | ||
|
|
9d47c3e84c | ||
|
|
c1222e5ebb | ||
|
|
d45001870f | ||
|
|
bc9ae39b85 | ||
|
|
6a5eaa381e | ||
|
|
1806102474 | ||
|
|
491fdd9c3b | ||
|
|
809fa567ce | ||
|
|
c8a449c0a5 | ||
|
|
790b8e1943 | ||
|
|
9cacd6a3cd | ||
|
|
71a8675ae4 | ||
|
|
5a9757be18 | ||
|
|
a9133a4d74 | ||
|
|
ccd396ac5e | ||
|
|
395fb0c7d8 | ||
|
|
e95cb1bf30 | ||
|
|
2fe62027ed | ||
|
|
0b3773de19 | ||
|
|
8f988d200e | ||
|
|
8eaaa88908 | ||
| 751ddd90bd | |||
| 3fe3f5a652 | |||
|
|
10f66d8ad4 | ||
|
|
cb0c5bc26f | ||
|
|
423195b975 | ||
|
|
8ea191ccc7 | ||
| 9e30f77a34 | |||
| f8d9c9e699 | |||
|
|
1e4c645a27 | ||
|
|
034c2bcf74 |
5 changed files with 61 additions and 6 deletions
2
.github/workflows/githubci.yml
vendored
2
.github/workflows/githubci.yml
vendored
|
|
@ -15,5 +15,5 @@ jobs:
|
||||||
run: bash ./actions_install.sh
|
run: bash ./actions_install.sh
|
||||||
- name: test platforms
|
- name: test platforms
|
||||||
run: |
|
run: |
|
||||||
python3 build_platform.py uno leonardo mega2560 zero esp8266 esp32 pico_rp2040 feather_m4_express
|
python3 build_platform.py uno leonardo mega2560 zero esp8266 esp32 pico_rp2040 feather_m4_express feather_rp2350
|
||||||
|
|
||||||
|
|
|
||||||
15
README.md
15
README.md
|
|
@ -76,3 +76,18 @@ The `doxy_gen_and_deploy.sh` script uses [Doxygen](https://www.doxygen.nl/) to g
|
||||||
for the library. Any issues, like missing documentation, will cause the CI to fail.
|
for the library. Any issues, like missing documentation, will cause the CI to fail.
|
||||||
See the [guide](https://learn.adafruit.com/the-well-automated-arduino-library/doxygen) for details on installing and running Doxygen locally. The guide also has some
|
See the [guide](https://learn.adafruit.com/the-well-automated-arduino-library/doxygen) for details on installing and running Doxygen locally. The guide also has some
|
||||||
[tips](https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips) on basic usage of Doxygen markup within your code.
|
[tips](https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips) on basic usage of Doxygen markup within your code.
|
||||||
|
|
||||||
|
### Preserving Folders in Documentation Branch
|
||||||
|
|
||||||
|
By default, the documentation deployment script cleans the gh-pages branch before adding new documentation. If you need to preserve certain folders (like custom web interfaces), you can set the `PRESERVE_FOLDERS` environment variable in your workflow:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: doxygen
|
||||||
|
env:
|
||||||
|
GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
|
||||||
|
PRETTYNAME : "My Arduino Library"
|
||||||
|
PRESERVE_FOLDERS: "webserial,assets"
|
||||||
|
run: bash ci/doxy_gen_and_deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
This will preserve the listed folders (comma-separated) during the documentation generation process.
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,8 @@ ALL_PLATFORMS={
|
||||||
# Arduino SAMD
|
# Arduino SAMD
|
||||||
"zero" : ["arduino:samd:arduino_zero_native", "0x68ed2b88", None, None],
|
"zero" : ["arduino:samd:arduino_zero_native", "0x68ed2b88", None, None],
|
||||||
"cpx" : ["arduino:samd:adafruit_circuitplayground_m0", "0x68ed2b88", None],
|
"cpx" : ["arduino:samd:adafruit_circuitplayground_m0", "0x68ed2b88", None],
|
||||||
|
# Arduino MBED GIGA
|
||||||
|
"giga" : ["arduino:mbed_giga:giga", None, None],
|
||||||
# Espressif
|
# Espressif
|
||||||
"esp8266" : ["esp8266:esp8266:huzzah:eesz=4M3M,xtal=80", None, None],
|
"esp8266" : ["esp8266:esp8266:huzzah:eesz=4M3M,xtal=80", None, None],
|
||||||
"esp32" : ["esp32:esp32:featheresp32:FlashFreq=80", None, None],
|
"esp32" : ["esp32:esp32:featheresp32:FlashFreq=80", None, None],
|
||||||
|
|
@ -16,6 +18,8 @@ ALL_PLATFORMS={
|
||||||
"wippersnapper_feather_esp32" : ["esp32:esp32:featheresp32:FlashFreq=80,PartitionScheme=min_spiffs", None, None],
|
"wippersnapper_feather_esp32" : ["esp32:esp32:featheresp32:FlashFreq=80,PartitionScheme=min_spiffs", None, None],
|
||||||
"feather_esp32_v2" : ["esp32:esp32:adafruit_feather_esp32_v2", None, None],
|
"feather_esp32_v2" : ["esp32:esp32:adafruit_feather_esp32_v2", None, None],
|
||||||
"qtpy_esp32" : ["esp32:esp32:adafruit_qtpy_esp32_pico", None, None],
|
"qtpy_esp32" : ["esp32:esp32:adafruit_qtpy_esp32_pico", None, None],
|
||||||
|
"sparklemotion_esp32" : ["esp32:esp32:sparklemotion", None, None],
|
||||||
|
"sparklemotionmini_esp32" : ["esp32:esp32:sparklemotionmini", None, None],
|
||||||
## ESP32-C3/C6
|
## ESP32-C3/C6
|
||||||
"feather_esp32c6" : ["esp32:esp32:adafruit_feather_esp32c6:FlashMode=qio", None, None],
|
"feather_esp32c6" : ["esp32:esp32:adafruit_feather_esp32c6:FlashMode=qio", None, None],
|
||||||
"wippersnapper_feather_esp32c6" : ["esp32:esp32:adafruit_feather_esp32c6:CDCOnBoot=cdc,CPUFreq=160,FlashFreq=80,FlashMode=qio,PartitionScheme=min_spiffs", None, None],
|
"wippersnapper_feather_esp32c6" : ["esp32:esp32:adafruit_feather_esp32c6:CDCOnBoot=cdc,CPUFreq=160,FlashFreq=80,FlashMode=qio,PartitionScheme=min_spiffs", None, None],
|
||||||
|
|
@ -48,6 +52,8 @@ ALL_PLATFORMS={
|
||||||
"qualia_s3_rgb666" : ["esp32:esp32:adafruit_qualia_s3_rgb666", "0xc47e5767", None],
|
"qualia_s3_rgb666" : ["esp32:esp32:adafruit_qualia_s3_rgb666", "0xc47e5767", None],
|
||||||
"qtpy_esp32s3" : ["esp32:esp32:adafruit_qtpy_esp32s3_nopsram", "0xc47e5767", None],
|
"qtpy_esp32s3" : ["esp32:esp32:adafruit_qtpy_esp32s3_nopsram", "0xc47e5767", None],
|
||||||
"qtpy_esp32s3_n4r2" : ["esp32:esp32:adafruit_qtpy_esp32s3_n4r2", "0xc47e5767", None],
|
"qtpy_esp32s3_n4r2" : ["esp32:esp32:adafruit_qtpy_esp32s3_n4r2", "0xc47e5767", None],
|
||||||
|
# ESP32-P4
|
||||||
|
"esp32p4" : ["esp32:esp32:esp32p4:JTAGAdapter=default,PSRAM=disabled,USBMode=default,CDCOnBoot=cdc,MSCOnBoot=default,DFUOnBoot=default,UploadMode=default,PartitionScheme=default,CPUFreq=360,FlashMode=qio,FlashFreq=80,FlashSize=4M,UploadSpeed=921600,DebugLevel=none,EraseFlash=none", "0x3d308e94", None],
|
||||||
# Adafruit AVR
|
# Adafruit AVR
|
||||||
"trinket_3v" : ["adafruit:avr:trinket3", None, None],
|
"trinket_3v" : ["adafruit:avr:trinket3", None, None],
|
||||||
"trinket_5v" : ["adafruit:avr:trinket5", None, None],
|
"trinket_5v" : ["adafruit:avr:trinket5", None, None],
|
||||||
|
|
@ -114,7 +120,7 @@ ALL_PLATFORMS={
|
||||||
"cpb" : ["adafruit:nrf52:cplaynrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
"cpb" : ["adafruit:nrf52:cplaynrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
||||||
"clue" : ["adafruit:nrf52:cluenrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
"clue" : ["adafruit:nrf52:cluenrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
||||||
"ledglasses_nrf52840" : ["adafruit:nrf52:ledglasses_nrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
"ledglasses_nrf52840" : ["adafruit:nrf52:ledglasses_nrf52840:softdevice=s140v6,debug=l0", "0xada52840", None],
|
||||||
# RP2040 (Philhower)
|
# RP2040 & RP2350 (Philhower)
|
||||||
"pico_rp2040" : ["rp2040:rp2040:rpipico:freq=125,flash=2097152_0", "0xe48bff56", None],
|
"pico_rp2040" : ["rp2040:rp2040:rpipico:freq=125,flash=2097152_0", "0xe48bff56", None],
|
||||||
"pico_rp2040_tinyusb" : ["rp2040:rp2040:rpipico:flash=2097152_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
"pico_rp2040_tinyusb" : ["rp2040:rp2040:rpipico:flash=2097152_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
"pico_rp2040_tinyusb_host" : ["rp2040:rp2040:rpipico:flash=2097152_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb_host", "0xe48bff56", None],
|
"pico_rp2040_tinyusb_host" : ["rp2040:rp2040:rpipico:flash=2097152_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb_host", "0xe48bff56", None],
|
||||||
|
|
@ -132,13 +138,22 @@ ALL_PLATFORMS={
|
||||||
"feather_rp2040_dvi" : ["rp2040:rp2040:adafruit_feather_dvi:freq=125,flash=8388608_0", "0xe48bff56", None],
|
"feather_rp2040_dvi" : ["rp2040:rp2040:adafruit_feather_dvi:freq=125,flash=8388608_0", "0xe48bff56", None],
|
||||||
"feather_rp2040_dvi_tinyusb" : ["rp2040:rp2040:adafruit_feather_dvi:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
"feather_rp2040_dvi_tinyusb" : ["rp2040:rp2040:adafruit_feather_dvi:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
"feather_rp2040_usbhost_tinyusb" : ["rp2040:rp2040:adafruit_feather_usb_host:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
"feather_rp2040_usbhost_tinyusb" : ["rp2040:rp2040:adafruit_feather_usb_host:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
"qt2040_trinkey" : ["rp2040:rp2040:adafruit_trinkeyrp2040qt:freq=125,flash=8388608_0", "0xe48bff56", None],
|
"feather_rp2350" : ["rp2040:rp2040:adafruit_feather_rp2350_hstx:arch=arm,flash=8388608_0,freq=150,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||||
|
"feather_rp2350_tinyusb" : ["rp2040:rp2040:adafruit_feather_rp2350_hstx:arch=arm,flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
|
"metro_rp2040" : ["rp2040:rp2040:adafruit_metro:flash=16777216_0,freq=200,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||||
|
"metro_rp2040_tinyusb" : ["rp2040:rp2040:adafruit_metro:flash=16777216_0,freq=200,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
|
"metro_rp2350" : ["rp2040:rp2040:adafruit_metro_rp2350:arch=arm,flash=16777216_0,freq=150,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||||
|
"metro_rp2350_tinyusb" : ["rp2040:rp2040:adafruit_metro_rp2350:arch=arm,flash=16777216_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
|
"qt2040_trinkey" : ["rp2040:rp2040:adafruit_trinkeyrp2040qt:flash=8388608_0,freq=125","0xe48bff56", None],
|
||||||
"qt2040_trinkey_tinyusb" : ["rp2040:rp2040:adafruit_trinkeyrp2040qt:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
"qt2040_trinkey_tinyusb" : ["rp2040:rp2040:adafruit_trinkeyrp2040qt:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
"qt_py_rp2040": ["rp2040:rp2040:adafruit_qtpy:freq=125,flash=8388608_0", "0xe48bff56", None],
|
"qt_py_rp2040": ["rp2040:rp2040:adafruit_qtpy:freq=125,flash=8388608_0", "0xe48bff56", None],
|
||||||
"qt_py_rp2040_tinyusb": ["rp2040:rp2040:adafruit_qtpy:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
"qt_py_rp2040_tinyusb": ["rp2040:rp2040:adafruit_qtpy:flash=8388608_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
"itsybitsy_rp2040" : ["rp2040:rp2040:adafruit_itsybitsy:freq=125,flash=8388608_524288", "0xe48bff56", None],
|
"itsybitsy_rp2040" : ["rp2040:rp2040:adafruit_itsybitsy:freq=125,flash=8388608_524288", "0xe48bff56", None],
|
||||||
"itsybitsy_rp2040_tinyusb" : ["rp2040:rp2040:adafruit_itsybitsy:flash=8388608_524288,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
"itsybitsy_rp2040_tinyusb" : ["rp2040:rp2040:adafruit_itsybitsy:flash=8388608_524288,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
|
"floppsy_rp2040" : ["rp2040:rp2040:adafruit_floppsy:freq=125,flash=16777216_14680064", "0xe48bff56", None],
|
||||||
|
"floppsy_rp2040_tinyusb" : ["rp2040:rp2040:adafruit_floppsy:flash=16777216_14680064,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
|
"fruit_jam" : ["rp2040:rp2040:adafruit_fruitjam:arch=arm,flash=16777216_0,freq=150,dbgport=Disabled,dbglvl=None,usbstack=picosdk", "0xe48bff56", None],
|
||||||
|
"fruit_jam_tinyusb" : ["rp2040:rp2040:adafruit_fruitjam:arch=arm,flash=16777216_0,freq=120,dbgport=Disabled,dbglvl=None,usbstack=tinyusb", "0xe48bff56", None],
|
||||||
# Attiny8xy, 16xy, 32xy (SpenceKonde)
|
# Attiny8xy, 16xy, 32xy (SpenceKonde)
|
||||||
"attiny3217" : ["megaTinyCore:megaavr:atxy7:chip=3217", None, None],
|
"attiny3217" : ["megaTinyCore:megaavr:atxy7:chip=3217", None, None],
|
||||||
"attiny3216" : ["megaTinyCore:megaavr:atxy6:chip=3216", None, None],
|
"attiny3216" : ["megaTinyCore:megaavr:atxy6:chip=3216", None, None],
|
||||||
|
|
@ -160,5 +175,5 @@ ALL_PLATFORMS={
|
||||||
"arcada_platforms" : ("pybadge", "pygamer", "hallowing_m4",
|
"arcada_platforms" : ("pybadge", "pygamer", "hallowing_m4",
|
||||||
"cpb", "cpx_ada"),
|
"cpb", "cpx_ada"),
|
||||||
"wippersnapper_platforms" : ("metro_m4_airliftlite_tinyusb", "pyportal_tinyusb"),
|
"wippersnapper_platforms" : ("metro_m4_airliftlite_tinyusb", "pyportal_tinyusb"),
|
||||||
"rp2040_platforms" : ("pico_rp2040", "feather_rp2040")
|
"rp2040_platforms" : ("pico_rp2040", "feather_rp2040", "feather_rp2350")
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -65,7 +65,8 @@ CHECK = u'\N{check mark}'
|
||||||
BSP_URLS = (
|
BSP_URLS = (
|
||||||
"https://adafruit.github.io/arduino-board-index/package_adafruit_index.json,"
|
"https://adafruit.github.io/arduino-board-index/package_adafruit_index.json,"
|
||||||
"http://arduino.esp8266.com/stable/package_esp8266com_index.json,"
|
"http://arduino.esp8266.com/stable/package_esp8266com_index.json,"
|
||||||
"https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json,"
|
#"https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json," # esp32 beta release
|
||||||
|
"https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json,"
|
||||||
"https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json,"
|
"https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json,"
|
||||||
"https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json,"
|
"https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json,"
|
||||||
"https://drazzy.good-enough.cloud/package_drazzy.com_index.json,"
|
"https://drazzy.good-enough.cloud/package_drazzy.com_index.json,"
|
||||||
|
|
|
||||||
|
|
@ -18,6 +18,7 @@ __AUTHOR__="Jeroen de Bruijn, modified by ladyada"
|
||||||
# Optional global variables:
|
# Optional global variables:
|
||||||
# - DOXYFILE : The Doxygen configuration file.
|
# - DOXYFILE : The Doxygen configuration file.
|
||||||
# - PRETTYNAME : A string name of the project (for the doxy headers)
|
# - PRETTYNAME : A string name of the project (for the doxy headers)
|
||||||
|
# - PRESERVE_FOLDERS : Comma-separated list of folders to preserve during cleanup
|
||||||
#
|
#
|
||||||
# For information on how to encrypt variables for Travis CI please go to
|
# For information on how to encrypt variables for Travis CI please go to
|
||||||
# https://docs.travis-ci.com/user/environment-variables/#Encrypted-Variables
|
# https://docs.travis-ci.com/user/environment-variables/#Encrypted-Variables
|
||||||
|
|
@ -84,6 +85,19 @@ git config --global push.default simple
|
||||||
git config user.name "Doxygen CI"
|
git config user.name "Doxygen CI"
|
||||||
git config user.email "ci-arduino@invalid"
|
git config user.email "ci-arduino@invalid"
|
||||||
|
|
||||||
|
# Check if PRESERVE_FOLDERS is set and back them up
|
||||||
|
if [ -n "$PRESERVE_FOLDERS" ]; then
|
||||||
|
echo "Preserving folders: $PRESERVE_FOLDERS"
|
||||||
|
mkdir -p /tmp/preserved
|
||||||
|
# Move preserved folders to temp dir
|
||||||
|
for folder in ${PRESERVE_FOLDERS//,/ }; do
|
||||||
|
if [ -d "$folder" ]; then
|
||||||
|
echo "Backing up folder: $folder"
|
||||||
|
cp -r "$folder" /tmp/preserved/
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
# Remove everything currently in the gh-pages branch.
|
# Remove everything currently in the gh-pages branch.
|
||||||
# GitHub is smart enough to know which files have changed and which files have
|
# GitHub is smart enough to know which files have changed and which files have
|
||||||
# stayed the same and will only update the changed files. So the gh-pages branch
|
# stayed the same and will only update the changed files. So the gh-pages branch
|
||||||
|
|
@ -99,6 +113,16 @@ else
|
||||||
rm -r -- !(index.html) || true
|
rm -r -- !(index.html) || true
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Restore preserved folders if they were backed up
|
||||||
|
if [ -n "$PRESERVE_FOLDERS" ]; then
|
||||||
|
for folder in ${PRESERVE_FOLDERS//,/ }; do
|
||||||
|
if [ -d "/tmp/preserved/$folder" ]; then
|
||||||
|
echo "Restoring folder: $folder"
|
||||||
|
cp -r "/tmp/preserved/$folder" ./
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
# Need to create a .nojekyll file to allow filenames starting with an underscore
|
# Need to create a .nojekyll file to allow filenames starting with an underscore
|
||||||
# to be seen on the gh-pages site. Therefore creating an empty .nojekyll file.
|
# to be seen on the gh-pages site. Therefore creating an empty .nojekyll file.
|
||||||
# Presumably this is only needed when the SHORT_NAMES option in Doxygen is set
|
# Presumably this is only needed when the SHORT_NAMES option in Doxygen is set
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue