Merge pull request #276 from lcpp-org/byexample-CI

[WIP] Add byexample workflow for doctesting README.md

This adds automatic tests of the code snippets in the readme. Currently this only covers the examples, and not the installation section - there are some difficulties with configuring byexample to handle the much more complicated output of those sections, and all of the content therein is already being run as part of the github workflows anyway.

What this will do is prevent changes to the examples from making the README outdated.

Author: drobnyjt

.github/workflows/readme_doctests.yml

@@ -0,0 +1,41 @@
+name: README doctests
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: udpate
+      run: |
+        sudo apt-get update
+    - name: Install curl
+      run: |
+        sudo apt-get install curl
+    - name: Install rust
+      run: |
+        curl --proto '=https' --tlsv1.2 -sSf -y https://sh.rustup.rs | sh
+        sudo apt-get install rustc cargo
+    - name: Install pip for Python-3
+      run: |
+        sudo apt-get install python3-pip python3-dev
+    - name: Install Python libraries
+      run: |
+        python3 -m pip install numpy shapely scipy matplotlib toml byexample
+    - name: install Python Bindings
+      run: |
+        python3 -m pip install setuptools_rust testresources setuptools wheel
+        python3 -m pip install --upgrade pip setuptools wheel
+        python3 -m pip install .
+    - name: run byexample
+      run: |
+        byexample -l python3,shell README.md -vvv --timeout 300 --no-enhance-diff -o '+norm-ws +rm=~ +term=dumb'