update docs css

seeq12 · Mar 4, 2024 · a82022b · a82022b
1 parent 429d279
commit a82022b
Show file tree

Hide file tree

Showing 9 changed files with 85 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -143,4 +143,5 @@ bin/
 venv/
 ```
 
+# built documentation
 /docs/build/
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 Seeq Corporation
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/addon.json b/addon.json
@@ -0,0 +1,27 @@
+{
+    "identifier": "com.seeq.addon.spc-accelerator",
+    "name": "SPC Accelerator",
+    "description": "DESCRIPTION HERE",
+    "version": "0.1.0",
+    "license": "Apache 2.0",
+    "icon": "fa fa-wrench",
+    "maintainer": "Seeq Corporation",
+    "previews": [
+      "docs/source/_static/preview.png"
+    ],
+    "elements": [
+      {
+        "name": "SPC Accelerator",
+        "identifier": "com.seeq.addon.spc-accelerator.ui",
+        "type": "AddOnTool",
+        "path": "add-on/add-on tools"
+      },
+      {
+        "name": "Run Rules",
+        "identifier": "com.seeq.addon.spc-accelerator.udf",
+        "type": "FormulaPackage",
+        "path": "add-on/udf"
+      }
+    ]
+  }
+
diff --git a/docs/source/_static/Seeq_logo_darkBlue_sm.png b/docs/source/_static/Seeq_logo_darkBlue_sm.png
diff --git a/docs/source/_static/Seeq_logo_white.svg b/docs/source/_static/Seeq_logo_white.svg
diff --git a/docs/source/_static/css/style.css b/docs/source/_static/css/style.css
@@ -6,4 +6,35 @@
  */
 
 /* This line is theme specific - it includes the base theme CSS */
-@import '../nature.css';  /* for Alabaster */
+@import '../nature.css';
+/* for Alabaster */
+
+.wy-side-nav-search {
+    background-color: #081F2C;
+}
+
+.wy-nav-side {
+    background: #081F2C;
+}
+
+.wy-side-nav-search img.logo {
+    width: 50% !important;
+}
+
+.wy-menu.wy-menu-vertical span {
+    color: #00FA87
+}
+
+.wy-nav-content-wrap {
+    background: #fcfcfc;
+}
+
+.wy-menu-vertical a:active {
+    background-color: #00FA87 !important;
+    color: #081F2C !important;
+}
+
+.wy-menu-vertical a:hover {
+    background-color: #00FA87 !important;
+    color: #081F2C !important;
+}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,27 +6,29 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'SPC Accelerator'
-copyright = '2024, Seeq Corporation'
-author = 'Chris Harp'
+project = "SPC Accelerator"
+copyright = "2024, Seeq Corporation"
+author = "Chris Harp"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = [
-    'myst_parser'
-]
+extensions = ["myst_parser"]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
 
-html_favicon = '_static/seeq-favicon.ico'
-html_logo = '_static/Seeq_logo_darkBlue_sm.png'
+html_favicon = "_static/seeq-favicon.ico"
+html_logo = "_static/Seeq_logo_white.svg"
+
+# CSS
+html_css_files = [
+    "css/style.css",
+]
diff --git a/docs/source/license.md b/docs/source/license.md
@@ -1,6 +1,6 @@
 # License
 
-Copyright [2024] [Seeq Corporation]
+Copyright 2024 Seeq Corporation
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the
 License. You may obtain a copy of the License at

diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md
@@ -1,3 +1,3 @@
 # User Guide
 
-This is where you'll include basic information on how to use the addon
+This is where you'll include basic information on how to use the addon.