33: cleanup docs, add integration test

xmtp · Jan 17, 2024 · 7f93c79 · 7f93c79
1 parent 2e62118
commit 7f93c79
Show file tree

Hide file tree

Showing 10 changed files with 945 additions and 141 deletions.
diff --git a/.github/site/siteindex.py b/.github/site/siteindex.py
@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Created on Mon Jul  6 15:07:00 2020
+
+generate a site index for the github pages site
+"""
+import sys
+
+header = """
+<html>
+<head>
+<title>xps-gateway</title>
+</head>
+<body>
+<h1>xps-gateway</h1>
+"""
+
+footer = """
+</body></html>
+"""
+
+if __name__ == "__main__":
+    package = sys.argv[1:]
+    print(header)
+    for p in package:
+        print("<a href=\"{}/\">{}</a><br>".format(p,p))
+    print(footer)
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -37,9 +37,6 @@ jobs:
           profile: minimal
           override: true
 
-      - name: Install Protoc
-        uses: arduino/setup-protoc@v2          
-
       - name: Run tests
         run: |
           cargo test
@@ -48,10 +45,11 @@ jobs:
       - name: Invoke cargo doc
         run: |
           rm -rf ./_site
-          cargo doc --lib --no-deps
+          cargo doc --workspace --no-deps
           rm -f target/doc/.lock
           cp -r target/doc _site
-          echo "<meta http-equiv=\"refresh\" content=\"0; url=registry\">" > _site/index.html
+          echo "generating site index"
+          python3 .github/site/siteindex.py xps_gateway registry messaging inbox > _site/index.html
           echo "Taking care of pedantic permissions requirements required by GitHub Pages"
           chmod -R +rX _site
         id: docgen