sparkfun · gigapod · Feb 15, 2025 · Feb 15, 2025 · Feb 15, 2025 · Feb 15, 2025
diff --git a/.github/workflows/build-deploy-ghpages.yml b/.github/workflows/build-deploy-ghpages.yml
@@ -0,0 +1,64 @@
+name: Build Documentation and Deploy
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+  pages: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: "true"
+
+      - name: Set Version
+        run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./docs/doxygen/doxygen-config
+
+      - name: Build Documentation
+        uses: mattnotmitt/doxygen-action@v1.9.5
+        with:
+          doxyfile-path: "./docs/doxygen/doxygen-config"
+
+      # Upload the documentation as an artifact
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@v3.0.1
+        with:
+          path: ./docs/html
+
+  # Deploy job
+  deploy:
+    # Add a dependency to the build job
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs/doxygen/doxygen-awesome-css"]
+	path = docs/doxygen/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,41 +1,6 @@
-SparkFun License Information
-============================
+MIT License
 
-SparkFun uses two different licenses for our files — one for hardware and one for code.
-
-Hardware
----------
-
-**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
-
-Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
-
-You are free to:
-
-Share — copy and redistribute the material in any medium or format
-Adapt — remix, transform, and build upon the material
-for any purpose, even commercially.
-The licensor cannot revoke these freedoms as long as you follow the license terms.
-Under the following terms:
-
-Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
-ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
-No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
-Notices:
-
-You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
-No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
-
-
-Code
---------
-Library contains code from multiple sources, see top of each file for specific licensing information.
-
-**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
-
-The MIT License (MIT)
-
-Copyright (c) 2020 SparkFun Electronics
+Copyright (c) 2025 SparkFun Electronics
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -54,7 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-
-**Analog Devices, firmware and software is subject to software license agreement. See SLA pdf included with this repo.**
-License terms outlines in:
-2021-05-20-LWSCADIN1110 Click Thru SLA .pdf
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ Repository Contents
 
 * **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
 * **/src** - Source files for the library (.cpp, .h).
-* **/Documentation** - Datasheet and application note for the XM125 and A121.
+* **/docs** - Datasheet and application note for the XM125 and A121.
 * **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
 * **library.properties** - General library properties for the Arduino package manager.
 * **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this library.

diff --git a/documents/A121 Assembly Test User Guide.pdf → docs/A121 Assembly Test User Guide.pdf b/documents/A121 Assembly Test User Guide.pdf → docs/A121 Assembly Test User Guide.pdf
diff --git a/...hing Reference Application User Guide.pdf → ...hing Reference Application User Guide.pdf b/...hing Reference Application User Guide.pdf → ...hing Reference Application User Guide.pdf
diff --git a/...nts/A121 Distance Detector User Guide.pdf → docs/A121 Distance Detector User Guide.pdf b/...nts/A121 Distance Detector User Guide.pdf → docs/A121 Distance Detector User Guide.pdf
diff --git a/...nts/A121 Presence Detector User Guide.pdf → docs/A121 Presence Detector User Guide.pdf b/...nts/A121 Presence Detector User Guide.pdf → docs/A121 Presence Detector User Guide.pdf
diff --git a/documents/A121 STM32CubeIDE User Guide.pdf → docs/A121 STM32CubeIDE User Guide.pdf b/documents/A121 STM32CubeIDE User Guide.pdf → docs/A121 STM32CubeIDE User Guide.pdf
diff --git a/documents/A121 SW Integration User Guide.pdf → docs/A121 SW Integration User Guide.pdf b/documents/A121 SW Integration User Guide.pdf → docs/A121 SW Integration User Guide.pdf
diff --git a/...ence Reference Application User Guide.pdf → ...ence Reference Application User Guide.pdf b/...ence Reference Application User Guide.pdf → ...ence Reference Application User Guide.pdf
diff --git a/...nts/A121 Sparse IQ Service User Guide.pdf → docs/A121 Sparse IQ Service User Guide.pdf b/...nts/A121 Sparse IQ Service User Guide.pdf → docs/A121 Sparse IQ Service User Guide.pdf
diff --git a/...evel Reference Application User Guide.pdf → ...evel Reference Application User Guide.pdf b/...evel Reference Application User Guide.pdf → ...evel Reference Application User Guide.pdf
diff --git a/documents/BUILDINFO.txt → docs/BUILDINFO.txt b/documents/BUILDINFO.txt → docs/BUILDINFO.txt
diff --git a/documents/Handbook.pdf → docs/Handbook.pdf b/documents/Handbook.pdf → docs/Handbook.pdf
diff --git a/...ents/I2C Distance Detector User Guide.pdf → docs/I2C Distance Detector User Guide.pdf b/...ents/I2C Distance Detector User Guide.pdf → docs/I2C Distance Detector User Guide.pdf
diff --git a/...ents/I2C Presence Detector User Guide.pdf → docs/I2C Presence Detector User Guide.pdf b/...ents/I2C Presence Detector User Guide.pdf → docs/I2C Presence Detector User Guide.pdf
diff --git a/documents/XM125 Software User Guide.pdf → docs/XM125 Software User Guide.pdf b/documents/XM125 Software User Guide.pdf → docs/XM125 Software User Guide.pdf
diff --git a/docs/doxygen/doxygen-awesome-css b/docs/doxygen/doxygen-awesome-css