Release Candidate 3 (#11)

Release Candidate 3

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Build and Deploy Docs
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: 
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install Doxygen
+        run: sudo sh -c 'echo deb http://cz.archive.ubuntu.com/ubuntu focal main universe >> /etc/apt/sources.list' && sudo apt-get update && sudo apt-get install -y -t focal doxygen
+      - name: Checkout
+        uses: actions/checkout@v2.0.0
+      - name: Checkout Doxygen Awesome
+        uses: Mushus/checkout-submodule@v1.0.1
+        with:
+          submodulePath: ./docs/doxygen-awesome-css
+      - name: Generate Documentation
+        run: ./build-docs.sh
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4.4.3
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: ./docs-output # The folder the action should deploy.

.gitignore

@@ -17,3 +17,6 @@ temp.errors
 .d/
 
 **/.DS_Store
+
+docs-output/
+**/__pycache__/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/doxygen-awesome-css"]
+	path = docs/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "endOfLine": "lf",
+  "printWidth": 80,
+  "useTabs": true,
+  "proseWrap": "always"
+}

README.md

@@ -1,8 +1,6 @@
 # robodash
 
-Robodash is a flexible, unified robot dashboard for the VEX V5 brain. It is
-built to improve compatibility with templates that provide LVGL-powered GUIs, as
-well as provide useful tools that take advantage of the V5 brain's LCD display.
-
-[Documentation](https://unwieldycat.github.io/robodash-docs/) ·
-[License](./LICENCE)
+Robodash is a flexible GUI toolkit for the VEX V5 brain. It is built to provide
+useful tools that take full advantage of the V5 brain's LCD display, as well as
+provide a foundation to improve compatibility with templates that provide
+LVGL-powered GUIs.

build-docs.sh

@@ -0,0 +1 @@
+doxygen ./docs/Doxyfile