diff --git a/.gitignore b/.gitignore index 180a612..c6d14d6 100644 --- a/.gitignore +++ b/.gitignore @@ -143,4 +143,5 @@ bin/ venv/ ``` +# built documentation /docs/build/ \ No newline at end of file diff --git a/LICENSE b/LICENSE index 261eeb9..b4ae1c3 100644 --- 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 new file mode 100644 index 0000000..b1846a6 --- /dev/null +++ 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" + } + ] + } + \ No newline at end of file diff --git a/docs/source/_static/Seeq_logo_darkBlue_sm.png b/docs/source/_static/Seeq_logo_darkBlue_sm.png deleted file mode 100644 index cbe8e0b..0000000 Binary files a/docs/source/_static/Seeq_logo_darkBlue_sm.png and /dev/null differ diff --git a/docs/source/_static/Seeq_logo_white.svg b/docs/source/_static/Seeq_logo_white.svg new file mode 100644 index 0000000..c80af19 --- /dev/null +++ b/docs/source/_static/Seeq_logo_white.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/source/_static/css/style.css b/docs/source/_static/css/style.css index 01643c8..e55e3fb 100644 --- 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 */ \ No newline at end of file +@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; +} \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 3d297bc..71adf2c 100644 --- 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' \ No newline at end of file +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 index e20053e..fbee838 100644 --- 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 index 64e05d6..0bccea9 100644 --- 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 \ No newline at end of file +This is where you'll include basic information on how to use the addon. \ No newline at end of file