Merge pull request #349 from jchanvfx/sphinx_theme_update

sphinx doc theme update

Author: jchanvfx

.github/workflows/sphinx_doc_build.yml

@@ -3,9 +3,11 @@ name: Build API Documentation
 
 on:
   # trigger this workflow when a release is published.
-  release:
-    types:
-      - published
+  push:
+    branches:
+      - main
+#    tags:
+#      - v*.*.*
 
 env:
   # environment variables.
@@ -32,10 +34,10 @@ jobs:
       # Install the python dependencies required for building.
       - name: Install Dependencies
         run: |
-            pip install -U sphinx
-            pip install sphinx-rtd-theme
+            pip install sphinx
             pip install PySide2
             pip install Qt.py
+            pip install autodocsumm
       # Set the local git configs.
       - name: Set Git Config
         run: |
@@ -45,7 +47,7 @@ jobs:
       - name: Update "gh-pages" branch
         run: |
             git checkout $GH_PAGES_BRANCH
-            git merge $SOURCE_BRANCH
+            git merge origin/$SOURCE_BRANCH
             git push origin $GH_PAGES_BRANCH
       # Build the sphinx api documentation.
       - name: Run Sphinx Build

docs/_static/custom.css

@@ -0,0 +1,62 @@
+:root{
+    --background:0 0% 100%;
+    --foreground:180 50% 20%;
+    --muted:210 40% 96.1%;
+    --muted-foreground:215.4 16.3% 46.9%;
+    --popover:0 0% 100%;
+    --popover-foreground:222.2 47.4% 11.2%;
+    --border:214.3 31.8% 91.4%;
+    --input:214.3 31.8% 91.4%;
+    --card:0 0% 100%;
+    --card-foreground:222.2 47.4% 11.2%;
+    --primary:222.2 47.4% 11.2%;
+    --primary-foreground:210 40% 98%;
+    --secondary:210 40% 96.1%;
+    --secondary-foreground:222.2 47.4% 11.2%;
+    --accent:210 40% 96.1%;
+    --accent-foreground:179 63% 46%;
+    --destructive:0 100% 50%;
+    --destructive-foreground:210 40% 98%;
+    --ring:215 20.2% 65.1%;
+    --radius:0.5rem;
+
+    --caption-color: #d779a9;
+    --a-link: #0081d7;
+}
+.dark {
+    --background: 250 20% 2%;
+    --foreground: 210 50% 80%;
+    --muted: 223 47% 11%;
+    --muted-foreground: 39 45% 64%;
+    --accent: 216 34% 17%;
+    --accent-foreground: 167 96% 38%;
+    --popover: 224 71% 4%;
+    --popover-foreground: 215 20.2% 65.1%;
+    --border: 216 34% 17%;
+    --input: 216 34% 17%;
+    --card: 224 71% 4%;
+    --card-foreground: 213 31% 91%;
+    --primary: 210 40% 98%;
+    --primary-foreground: 222.2 47.4% 1.2%;
+    --secondary: 222.2 47.4% 11.2%;
+    --secondary-foreground: 210 40% 98%;
+    --destructive: 0 63% 31%;
+    --destructive-foreground: 210 40% 98%;
+    --ring: 216 34% 17%;
+    --radius: 0.5rem;
+
+    --caption-color: #7d2853;
+    --a-link: #48cdf8;
+}
+
+
+.caption {
+    color: var(--caption-color);
+}
+#content a:not(.toc-backref) {
+    color: var(--a-link);
+    font-weight: 500;
+    text-decoration-line: none;
+    text-decoration-thickness: from-font;
+    text-underline-offset: 4px;
+}

docs/_static/pygments.css

@@ -1,20 +1,26 @@
 .linenos,
 td.lineos {
-    background: #2e3133;
     margin: 0px 10px;
     padding: 1px 8px;
+    color: #818181;
 }
 .linenos pre {
     background-color: transparent;
     color: #aaa;
     -webkit-box-shadow: none;
     -moz-box-shadow: none;
 }
-.hll { background-color: #233150 }
+.hll {
+    background-color: #233150:
+    display: block;
+}
 .code { background: #232629; !important }
-.highlight pre { background: #1a1c1f; !important }
 .highlight pre {
-    color: #f8f8f2; 
+    background: #0b0d0f !important;
+    border-radius: 10px !important;
+}
+.highlight pre {
+    color: #2fb37a;
     border: 0px; 
     border-radius: 0px;
     -webkit-box-shadow: none;