add github pages docs with auto generated schematics and pcb layout

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Docs
+
+# only build single instance of docs for latest main branch
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: |
+          sudo add-apt-repository --yes ppa:kicad/kicad-7.0-releases
+          sudo apt update
+          sudo apt install -y --install-recommends kicad
+
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+
+      - name: Build Book
+        run: docs/generate_docs.sh
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docs/book'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/kicad.yml

@@ -0,0 +1,40 @@
+name: PCB
+
+# build for each push and pull request
+on: [push, pull_request]
+
+jobs:
+  fabrication:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: |
+          sudo add-apt-repository --yes ppa:kicad/kicad-7.0-releases
+          sudo apt update
+          sudo apt install -y --install-recommends kicad
+          sudo apt-get install -y zip
+
+      - name: Generate fabrication files
+        run: |
+          ./hardware/generate_fab.sh
+
+      - name: Upload board files
+        uses: actions/upload-artifact@v4.0.0
+        with:
+          name: dispensy-pcb
+          path: hardware/fabrication
+
+      - name: Upload release files
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v1
+        with:
+          files: hardware/fab.zip

README.md

@@ -1,3 +1,6 @@
 # Dispensy
 
+![PCB](https://github.com/drinkrobotics/dispensy/actions/workflows/kicad.yml/badge.svg)
+![Docs](https://github.com/drinkrobotics/dispensy/actions/workflows/docs.yml/badge.svg)
+
 One day aims to be a new hardware base for the [DrinkRobotics UbaBot](https://www.xythobuz.de/drinkrobotics.html).

docs/.gitignore

@@ -0,0 +1,3 @@
+book
+src/plot
+src/inc_*.md

docs/README.md

@@ -0,0 +1,13 @@
+# Dispensy Documentation
+
+You can find the [documentation here on GitHub pages](https://drinkrobotics.github.io/dispensy/).
+This file is intended for contributors that want to modify this website!
+
+## Local Build
+
+The docs are built using [mdbook](https://github.com/rust-lang/mdBook).
+Get the [latest release from GitHub](https://github.com/rust-lang/mdBook/releases) for a pre-built binary if you want to test changes to the docs locally.
+
+    mdbook serve --open docs
+
+This will open your browser to a local development instance of the docs.

docs/book.toml

@@ -0,0 +1,11 @@
+[book]
+title = "Dispensy"
+authors = ["xythobuz"]
+description = "Documentation for Dispensy, the universal Cocktail Machine hardware."
+language = "en"
+multilingual = false
+src = "src"
+
+[output.html]
+git-repository-url = "https://github.com/drinkrobotics/dispensy"
+edit-url-template = "https://github.com/drinkrobotics/dispensy/edit/main/docs/{path}"

docs/generate_docs.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+cd "$(dirname "$0")"
+
+echo "Generating plots"
+rm -rf src/plot
+../hardware/generate_plot.sh
+cp -r ../hardware/plot src
+
+echo "Generating plot includes"
+rm -rf src/inc_dispensy_sch.md
+for f in src/plot/dispensy_sch.svg/*.svg; do
+    file=`echo $f | sed 's:src/:./:g'`
+    name=`echo $f | sed 's:src/plot/dispensy_sch.svg/::g' | sed 's:.svg::g'`
+    echo "<h2>$name</h2>" >> src/inc_dispensy_sch.md
+    echo "<div style=\"background-color: white;\">" >> src/inc_dispensy_sch.md
+    echo "<a href=\"$file\">" >> src/inc_dispensy_sch.md
+    echo "<img src=\"$file\" alt=\"Main-Board PCB layout as SVG\">" >> src/inc_dispensy_sch.md
+    echo "</a></div>" >> src/inc_dispensy_sch.md
+    echo >> src/inc_dispensy_sch.md
+done
+
+echo "Generating docs"
+if [ "$1" = "serve" ] ; then
+    mdbook serve --open
+elif [ "$1" = "build" ] ; then
+    mdbook build
+else
+    echo "Invalid command. 'build' or 'serve'."
+fi

docs/src/SUMMARY.md

@@ -0,0 +1,11 @@
+# Summary
+
+# Dispensy
+
+- [Introduction](./introduction.md)
+
+# Hardware
+
+- [Main-Board](./main_board.md)
+  - [Schematics](./main_board_sch.md)
+  - [PCB Layout](./main_board_pcb.md)

docs/src/introduction.md

@@ -0,0 +1,3 @@
+# Introduction
+
+**TODO** work in progress

docs/src/main_board.md

@@ -0,0 +1,3 @@
+# Main-Board
+
+**TODO** work in progress

docs/src/main_board_pcb.md

@@ -0,0 +1,11 @@
+# Main-Board PCB Layout
+
+This page shows the current version of the PCB layout as SVG graphics.
+
+You can also view the [Main-Board PCB layout as PDF](./plot/dispensy_pcb.pdf).
+
+<div style="background-color: white;">
+    <a href="./plot/dispensy_pcb.svg">
+        <img src="./plot/dispensy_pcb.svg" alt="Main-Board PCB layout as SVG">
+    </a>
+</div>

docs/src/main_board_sch.md

@@ -0,0 +1,7 @@
+# Main-Board Schematics
+
+This page shows the current version of the schematics as SVG graphics.
+
+You can also view the [Main-Board schematics as PDF](./plot/dispensy_sch.pdf).
+
+{{#include inc_dispensy_sch.md}}

hardware/generate_plot.sh

@@ -24,4 +24,5 @@ do
         -l $LAYER \
         -o $OUTDIR/dispensy_pcb.$VAR \
         dispensy.kicad_pcb
+    echo
 done