Add Python and project specific customizations. Add workflows.

Author: malcolm-sparkfun

.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

docs/doxygen/doxygen-config

@@ -42,7 +42,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "SparkFun Toolkit"
+PROJECT_NAME           = "Qwiic_SerLCD_Py"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -54,7 +54,7 @@ PROJECT_NAME           = "SparkFun Toolkit"
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Core Functionality Library"
+PROJECT_BRIEF          = "Python module for I2C control of the SparkFun Qwiic Serial LCDs"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -253,7 +253,7 @@ MULTILINE_CPP_IS_BRIEF = NO
 # documentation blocks is shown as doxygen documentation.
 # The default value is: YES.
 
-PYTHON_DOCSTRING       = YES
+PYTHON_DOCSTRING       = NO
 
 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
 # documentation from any documented member that it re-implements.
@@ -305,7 +305,7 @@ OPTIMIZE_OUTPUT_FOR_C  = NO
 # qualified scopes will look different, etc.
 # The default value is: NO.
 
-OPTIMIZE_OUTPUT_JAVA   = NO
+OPTIMIZE_OUTPUT_JAVA   = YES
 
 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
 # sources. Doxygen will then generate output that is tailored for Fortran.
@@ -949,7 +949,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src \
+INPUT                  = qwiic_serlcd.py \
                          README.md \
                          docs
 
@@ -991,13 +991,7 @@ INPUT_FILE_ENCODING    =
 # be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
 
-FILE_PATTERNS          = *.c \
-                         *.cc \
-                         *.cxx \
-                         *.cpp \
-                         *.c++ \
-                         *.h \
-                         *.hpp \
+FILE_PATTERNS          = *.py \
                          *.markdown \
                          *.md \
                          *.dox

docs/doxygen/doxygen-custom/header.html

@@ -10,14 +10,14 @@
     <meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <!-- BEGIN opengraph metadata -->
-    <meta property="og:title" content="SparkFun Toolkit" />
-    <meta property="og:description" content="Common Functionality for Arduino Libraries" />
-    <meta property="og:url" content="https://docs.sparkfun.com/SparkFun_Toolkit/" />
+    <meta property="og:title" content="Qwiic_SerLCD_Py" />
+    <meta property="og:description" content="Python module for I2C control of the SparkFun Qwiic Serial LCDs" />
+    <meta property="og:url" content="https://docs.sparkfun.com/Qwiic_SerLCD_Py/" />
     <!-- END opengraph metadata -->
 
     <!-- BEGIN twitter metadata -->
-    <meta name="twitter:title" content="SparkFun Toolkit" />
-    <meta name="twitter:description" content="Common Functionality for Arduino Libraries." />
+    <meta name="twitter:title" content="Qwiic_SerLCD_Py" />
+    <meta name="twitter:description" content="Python module for I2C control of the SparkFun Qwiic Serial LCDs" />
     <!-- END twitter metadata -->
 
     <!--BEGIN PROJECT_NAME-->
@@ -38,7 +38,7 @@
 <body>
 
     <!-- https://tholman.com/github-corners/ -->
-    <a href="https://github.com/sparkfun/SparkFun_Toolkit" class="github-corner" title="View source on GitHub">
+    <a href="https://github.com/sparkfun/Qwiic_SerLCD_Py" class="github-corner" title="View source on GitHub">
         <svg viewBox="0 0 250 250" style="position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true">
             <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
             <path