update documenmts

owlbarn · Mar 8, 2024 · c7dbf43 · c7dbf43
1 parent f2381ea
commit c7dbf43
Show file tree

Hide file tree

Showing 2,078 changed files with 26,626 additions and 28,066 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -32,17 +32,13 @@ jobs:
       - name: OCaml Deps
         run: opam install ocaml-compiler-libs alcotest conf-openblas ctypes dune-configurator stdio npy odoc
 
+      # @TODO: the doc for submodules, e.g. Matrix.S, are not generated 
+      # Currently rely on manually update docs into the /docs directory 
       - name: Build doc
-        run: opam exec -- dune build @doc --verbose
-
-      - name: inspect
-        run: |
-          ls _build/default/_doc/_html/owl/Owl
-          ls _build/default/_doc/_html/owl/Owl_dense_matrix
-          ls _build/default/_doc/_html/
+        run: | 
+          opam exec -- dune build @doc
           cp docs/*.js  _build/default/_doc/_html/
           cp docs/*.css _build/default/_doc/_html/
-        # cat docs/mathjax.js docs/highlight.pack.js >> _build/default/_doc/_html/highlight.pack.js
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

diff --git a/Makefile b/Makefile
@@ -36,7 +36,7 @@ uninstall:
 .PHONY: doc
 doc:
 	dune build @doc
-	cat docs/mathjax.js docs/highlight.pack.js >> _build/default/_doc/_html/highlight.pack.js
+# cat docs/mathjax.js docs/highlight.pack.js >> _build/default/_doc/_html/highlight.pack.js
 	cp -r _build/default/_doc/_html/* docs
 
 .PHONY: distclean cleanall

diff --git a/docs/highlight.pack.js b/docs/highlight.pack.js
diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <title>index</title>
-    <link rel="stylesheet" href="./odoc.css"/>
+    <link rel="stylesheet" href="./odoc.support/odoc.css"/>
     <meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
   </head>

diff --git a/docs/mathjax.js b/docs/mathjax.js
diff --git a/docs/fonts/KaTeX_AMS-Regular.woff2 → ...doc.support/fonts/KaTeX_AMS-Regular.woff2 b/docs/fonts/KaTeX_AMS-Regular.woff2 → ...doc.support/fonts/KaTeX_AMS-Regular.woff2
diff --git a/docs/fonts/KaTeX_Caligraphic-Bold.woff2 → ...upport/fonts/KaTeX_Caligraphic-Bold.woff2 b/docs/fonts/KaTeX_Caligraphic-Bold.woff2 → ...upport/fonts/KaTeX_Caligraphic-Bold.woff2
diff --git a/docs/fonts/KaTeX_Caligraphic-Regular.woff2 → ...ort/fonts/KaTeX_Caligraphic-Regular.woff2 b/docs/fonts/KaTeX_Caligraphic-Regular.woff2 → ...ort/fonts/KaTeX_Caligraphic-Regular.woff2
diff --git a/docs/fonts/KaTeX_Fraktur-Bold.woff2 → ...oc.support/fonts/KaTeX_Fraktur-Bold.woff2 b/docs/fonts/KaTeX_Fraktur-Bold.woff2 → ...oc.support/fonts/KaTeX_Fraktur-Bold.woff2
diff --git a/docs/fonts/KaTeX_Fraktur-Regular.woff2 → ...support/fonts/KaTeX_Fraktur-Regular.woff2 b/docs/fonts/KaTeX_Fraktur-Regular.woff2 → ...support/fonts/KaTeX_Fraktur-Regular.woff2
diff --git a/docs/fonts/KaTeX_Main-Bold.woff2 → .../odoc.support/fonts/KaTeX_Main-Bold.woff2 b/docs/fonts/KaTeX_Main-Bold.woff2 → .../odoc.support/fonts/KaTeX_Main-Bold.woff2
diff --git a/docs/fonts/KaTeX_Main-BoldItalic.woff2 → ...support/fonts/KaTeX_Main-BoldItalic.woff2 b/docs/fonts/KaTeX_Main-BoldItalic.woff2 → ...support/fonts/KaTeX_Main-BoldItalic.woff2
diff --git a/docs/fonts/KaTeX_Main-Italic.woff2 → ...doc.support/fonts/KaTeX_Main-Italic.woff2 b/docs/fonts/KaTeX_Main-Italic.woff2 → ...doc.support/fonts/KaTeX_Main-Italic.woff2
diff --git a/docs/fonts/KaTeX_Main-Regular.woff2 → ...oc.support/fonts/KaTeX_Main-Regular.woff2 b/docs/fonts/KaTeX_Main-Regular.woff2 → ...oc.support/fonts/KaTeX_Main-Regular.woff2
diff --git a/docs/fonts/KaTeX_Math-BoldItalic.woff2 → ...support/fonts/KaTeX_Math-BoldItalic.woff2 b/docs/fonts/KaTeX_Math-BoldItalic.woff2 → ...support/fonts/KaTeX_Math-BoldItalic.woff2
diff --git a/docs/fonts/KaTeX_Math-Italic.woff2 → ...doc.support/fonts/KaTeX_Math-Italic.woff2 b/docs/fonts/KaTeX_Math-Italic.woff2 → ...doc.support/fonts/KaTeX_Math-Italic.woff2
diff --git a/docs/fonts/KaTeX_SansSerif-Bold.woff2 → ....support/fonts/KaTeX_SansSerif-Bold.woff2 b/docs/fonts/KaTeX_SansSerif-Bold.woff2 → ....support/fonts/KaTeX_SansSerif-Bold.woff2
diff --git a/docs/fonts/KaTeX_SansSerif-Italic.woff2 → ...upport/fonts/KaTeX_SansSerif-Italic.woff2 b/docs/fonts/KaTeX_SansSerif-Italic.woff2 → ...upport/fonts/KaTeX_SansSerif-Italic.woff2
diff --git a/docs/fonts/KaTeX_SansSerif-Regular.woff2 → ...pport/fonts/KaTeX_SansSerif-Regular.woff2 b/docs/fonts/KaTeX_SansSerif-Regular.woff2 → ...pport/fonts/KaTeX_SansSerif-Regular.woff2
diff --git a/docs/fonts/KaTeX_Script-Regular.woff2 → ....support/fonts/KaTeX_Script-Regular.woff2 b/docs/fonts/KaTeX_Script-Regular.woff2 → ....support/fonts/KaTeX_Script-Regular.woff2
diff --git a/docs/fonts/KaTeX_Size1-Regular.woff2 → ...c.support/fonts/KaTeX_Size1-Regular.woff2 b/docs/fonts/KaTeX_Size1-Regular.woff2 → ...c.support/fonts/KaTeX_Size1-Regular.woff2
diff --git a/docs/fonts/KaTeX_Size2-Regular.woff2 → ...c.support/fonts/KaTeX_Size2-Regular.woff2 b/docs/fonts/KaTeX_Size2-Regular.woff2 → ...c.support/fonts/KaTeX_Size2-Regular.woff2
diff --git a/docs/fonts/KaTeX_Size3-Regular.woff2 → ...c.support/fonts/KaTeX_Size3-Regular.woff2 b/docs/fonts/KaTeX_Size3-Regular.woff2 → ...c.support/fonts/KaTeX_Size3-Regular.woff2
diff --git a/docs/fonts/KaTeX_Size4-Regular.woff2 → ...c.support/fonts/KaTeX_Size4-Regular.woff2 b/docs/fonts/KaTeX_Size4-Regular.woff2 → ...c.support/fonts/KaTeX_Size4-Regular.woff2
diff --git a/docs/fonts/KaTeX_Typewriter-Regular.woff2 → ...port/fonts/KaTeX_Typewriter-Regular.woff2 b/docs/fonts/KaTeX_Typewriter-Regular.woff2 → ...port/fonts/KaTeX_Typewriter-Regular.woff2
diff --git a/docs/odoc.support/fonts/fira-mono-v14-latin-500.woff2 b/docs/odoc.support/fonts/fira-mono-v14-latin-500.woff2
diff --git a/docs/odoc.support/fonts/fira-mono-v14-latin-regular.woff2 b/docs/odoc.support/fonts/fira-mono-v14-latin-regular.woff2
diff --git a/docs/odoc.support/fonts/fira-sans-v17-latin-500.woff2 b/docs/odoc.support/fonts/fira-sans-v17-latin-500.woff2
diff --git a/docs/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2 b/docs/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2
diff --git a/docs/odoc.support/fonts/fira-sans-v17-latin-700.woff2 b/docs/odoc.support/fonts/fira-sans-v17-latin-700.woff2
diff --git a/docs/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2 b/docs/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2
diff --git a/docs/odoc.support/fonts/fira-sans-v17-latin-italic.woff2 b/docs/odoc.support/fonts/fira-sans-v17-latin-italic.woff2
diff --git a/docs/odoc.support/fonts/fira-sans-v17-latin-regular.woff2 b/docs/odoc.support/fonts/fira-sans-v17-latin-regular.woff2
diff --git a/docs/odoc.support/fonts/noticia-text-v15-latin-700.woff2 b/docs/odoc.support/fonts/noticia-text-v15-latin-700.woff2
diff --git a/docs/odoc.support/fonts/noticia-text-v15-latin-italic.woff2 b/docs/odoc.support/fonts/noticia-text-v15-latin-italic.woff2
diff --git a/docs/odoc.support/fonts/noticia-text-v15-latin-regular.woff2 b/docs/odoc.support/fonts/noticia-text-v15-latin-regular.woff2
diff --git a/docs/odoc.support/highlight.pack.js b/docs/odoc.support/highlight.pack.js
diff --git a/docs/katex.min.css → docs/odoc.support/katex.min.css b/docs/katex.min.css → docs/odoc.support/katex.min.css
diff --git a/docs/katex.min.js → docs/odoc.support/katex.min.js b/docs/katex.min.js → docs/odoc.support/katex.min.js