ci: generate the documentation

fstamour · Aug 13, 2023 · a12682a · a12682a
1 parent 7c475e6
commit a12682a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 8 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -58,3 +58,9 @@ jobs:
       - name: Tests
         shell: bash
         run: scripts/test.sh
+
+      - name: 'Upload Artifact'
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: docs/
diff --git a/tests/documentation.lisp b/tests/documentation.lisp
@@ -40,11 +40,15 @@
 (define-test find-undocumented-symbols
   (let ((undocumented-symbols (find-undocumented-symbols-in-dummy-package)))
     (is
-      equal undocumented-symbols
-      '((:function breeze.dummy.test:function-undocumented)
-        (:generic-method breeze.dummy.test:generic-function-undocumented)
-        (:method breeze.dummy.test:another-generic-function)
-        (:method breeze.dummy.test:generic-function-undocumented)
-        (:package "BREEZE.DUMMY.TEST")
-        (:special-variable breeze.dummy.test:*bound-variable-undocumented*)
-        (:special-variable breeze.dummy.test:*unbound-variable-undocumented*)))))
+     equal undocumented-symbols
+     '((:function breeze.dummy.test:function-undocumented)
+       (:generic-method breeze.dummy.test:generic-function-undocumented)
+       (:method breeze.dummy.test:another-generic-function)
+       (:method breeze.dummy.test:generic-function-undocumented)
+       (:package "BREEZE.DUMMY.TEST")
+       (:special-variable breeze.dummy.test:*bound-variable-undocumented*)
+       (:special-variable breeze.dummy.test:*unbound-variable-undocumented*)))))
+
+
+(define-test generate-documentation
+  (breeze.documentation::generate-documentation))