Docs: doxygen-based

Author: josuah

.github/workflows/pages.yml

@@ -1,5 +1,5 @@
-# Sample workflow for building and deploying a Jekyll site to GitHub Pages
-name: Deploy Jekyll site to Pages
+# Sample workflow for building and deploying a Doxygen site to GitHub Pages
+name: Deploy Doxygen site to Pages
 
 on:
   push:
@@ -18,31 +18,26 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
-    env:
-      BUNDLE_GEMFILE: ${{ github.workspace }}/Docs/Gemfile
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.0'   # Not needed with a .ruby-version file
-          bundler-cache: true   # runs 'bundle install' and caches installed gems automatically
-          cache-version: 0      # Increment this number if you need to re-download cached gems
+      - name: Setup Doxygen
+        run: |
+          sudo apt update
+          sudo apt install doxygen
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v2
       - name: Build with Jekyll
         # Outputs to the './_site' directory by default
         run: |
           cd Docs
-          bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
-        env:
-          JEKYLL_ENV: production
+          git submodule update --init
+          doxygen
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
-          path: "Docs/_site"
+          path: "Docs/html"
 
   deploy:
     environment:

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "Firmware/pico-sdk"]
 	path = Firmware/pico-sdk
 	url = https://github.com/raspberrypi/pico-sdk
+[submodule "Docs/doxygen-awesome-css"]
+	path = Docs/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git

CNAME

@@ -1,10 +1,2 @@
-# Copied from https://github.com/github/gitignore/blob/main/Jekyll.gitignore
-# Ignore metadata generated by Jekyll
-_site/
-.sass-cache/
-.jekyll-cache/
-.jekyll-metadata
-
-# Ignore folders generated by Bundler
-.bundle/
-vendor/
+html
+latex

Docs/.gitignore

@@ -0,0 +1,15 @@
+PROJECT_NAME           = "pico-ice"
+PROJECT_BRIEF          = RaspberryPi Pico with an iCE40 FPGA
+OPTIMIZE_OUTPUT_FOR_C  = YES
+SHOW_FILES             = NO
+SHOW_NAMESPACES        = NO
+INPUT                  = ../ ../doc/ ../include
+EXCLUDE                = ../CONTRIBUTING.md ../LICENSE.md ../CHANGELOG.md ../README.md
+IMAGE_PATH             = images pinout
+USE_MDFILE_AS_MAINPAGE = index.md
+HTML_FOOTER            = footer.html
+HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css
+HTML_COLORSTYLE        = LIGHT
+DISABLE_INDEX          = NO
+GENERATE_TREEVIEW      = YES
+FULL_SIDEBAR           = YES

Docs/Doxyfile

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<doxygenlayout version="1.0">
+  <navindex>
+    <tab type="mainpage" title="Home"/>
+    <tab type="pages" title="Wiki"/>
+    <tab type="topics" title="SDK API"/>
+    <tab type="user" title="Examples" url="https://github.com/tinyvision-ai-inc/pico-ice-sdk/tree/main/examples"/>
+  </navindex>
+</doxygenlayout>