added style sheet and finalized grid setup

slacgismo · Jan 8, 2024 · 42ef1f6 · 42ef1f6
1 parent d46d9cb
commit 42ef1f6
Show file tree

Hide file tree

Showing 7 changed files with 139 additions and 68 deletions.
diff --git a/docs/source/_static/solardatatools.css b/docs/source/_static/solardatatools.css
@@ -0,0 +1,74 @@
+/* Main page overview cards */
+
+.sd-card {
+  background: #fff;
+  border-radius: 0;
+  padding: 30px 10px 20px 10px;
+  margin: 10px 0px;
+}
+
+.sd-card .sd-card-header {
+  text-align: center;
+}
+
+.sd-card .sd-card-header .sd-card-text {
+  margin: 0px;
+}
+
+.sd-card .sd-card-img-top {
+  height: 52px;
+  width: 52px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.sd-card .sd-card-header {
+  border: none;
+  background-color: white;
+  color: #150458 !important;
+  font-size: var(--pst-font-size-h5);
+  font-weight: bold;
+  padding: 2.5rem 0rem 0.5rem 0rem;
+}
+
+.sd-card .sd-card-footer {
+  border: none;
+  background-color: white;
+}
+
+.sd-card .sd-card-footer .sd-card-text {
+  max-width: 220px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+/* Dark theme tweaking */
+html[data-theme=dark] .sd-card img[src*='.svg'] {
+    filter: invert(0.82) brightness(0.8) contrast(1.2);
+}
+
+/* Main index page overview cards */
+html[data-theme=dark] .sd-card {
+  background-color:var(--pst-color-background);
+}
+
+html[data-theme=dark] .sd-shadow-sm {
+    box-shadow: 0 .1rem 1rem rgba(250, 250, 250, .6) !important
+}
+
+html[data-theme=dark] .sd-card .sd-card-header {
+  background-color:var(--pst-color-background);
+  color: #150458 !important;
+}
+
+html[data-theme=dark] .sd-card .sd-card-footer {
+  background-color:var(--pst-color-background);
+}
+
+html[data-theme=dark] h1 {
+  color: var(--pst-color-primary);
+}
+
+html[data-theme=dark] h3 {
+  color: #0a6774;
+}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -13,14 +13,15 @@
 import pydata_sphinx_theme
 import os
 import sys
+from datetime import date
 
 sys.path.insert(0, os.path.abspath("../.."))
 
 
 # -- Project information -----------------------------------------------------
 
 project = "Solar Data Tools"
-copyright = "2021, Bennet Meyers"
+copyright = '%s, Bennet Meyers' % date.today().year
 author = "Bennet Meyers"
 
 
@@ -29,15 +30,25 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx_design", "sphinx.ext.autodoc", "sphinx.ext.napoleon"]
+extensions = [
+    "sphinx_design",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon"
+]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+templates_path = [
+    "_templates"
+]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store"
+]
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -50,6 +61,19 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
+#html_title = f"{project} v{release}"
 html_static_path = ['_static']
+html_css_files = ["solardatatools.css"]
+html_copy_source = False
 
 master_doc = "index"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    "external_links": [],
+    "navbar_align": "left",
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
+    "show_version_warning_banner": True,
+}
diff --git a/docs/source/_static/index_images/api.svg → docs/source/images/api.svg b/docs/source/_static/index_images/api.svg → docs/source/images/api.svg
diff --git a/...urce/_static/index_images/contributor.svg → docs/source/images/contributor.svg b/...urce/_static/index_images/contributor.svg → docs/source/images/contributor.svg
diff --git a/.../_static/index_images/getting_started.svg → docs/source/images/getting_started.svg b/.../_static/index_images/getting_started.svg → docs/source/images/getting_started.svg
diff --git a/...ource/_static/index_images/user_guide.svg → docs/source/images/user_guide.svg b/...ource/_static/index_images/user_guide.svg → docs/source/images/user_guide.svg
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,6 +3,11 @@ Solar Data Tools
 
 |PyPI release| |Anaconda Cloud release|
 
+.. |PyPI release| image:: https://img.shields.io/pypi/v/solar-data-tools.svg
+   :target: https://pypi.org/project/solar-data-tools/
+.. |Anaconda Cloud release| image:: https://anaconda.org/slacgismo/solar-data-tools/badges/version.svg
+   :target: https://anaconda.org/slacgismo/solar-data-tools
+
 Tools for performing common tasks on solar PV data signals. These tasks include finding clear days in a data set, common data transforms, and fixing time stamp issues. These tools are designed to be automatic and require little if any input from the user. Libraries are included to help with data IO and plotting as well.
 
 See `notebooks <https://github.com/slacgismo/solar-data-tools/tree/master/notebooks>`_ folder for examples.
@@ -16,108 +21,76 @@ See `notebooks <https://github.com/slacgismo/solar-data-tools/tree/master/notebo
    index_dev
    index_project_details
 
-.. grid:: 2
+.. grid:: 1 2 2 2
+    :gutter: 4
+    :padding: 2 2 0 0
+    :class-container: sd-text-center
 
-    .. grid-item-card::
-        :img-top: ../source/_static/index_images/getting_started.svg
-            :width: 25%
-            :height: 25%
-        :width: 75%
-        :height: 50%
-
-        Getting Started
-        ^^^^^^^^^^^^^^^
+    .. grid-item-card:: Getting Started
+        :img-top: ../source/images/getting_started.svg
 
         New to Solar Data Tools? Check out the getting started guides. They contain an
         introduction to the main concepts and links to additional tutorials.
 
         +++
 
         .. button-ref:: index_getting_started
-            :expand:
-            :color: primary
             :click-parent:
+            :color: primary
+            :expand:
 
             To the getting started guides
 
-    .. grid-item-card::
-        :img-top: ../source/_static/index_images/user_guide.svg
-
-        User Guide
-        ^^^^^^^^^^
+    .. grid-item-card:: User Guide
+        :img-top: ../source/images/user_guide.svg
+        :class-card: intro-card
+        :shadow: md
 
         The user guide provides in-depth information on the key concepts
-        of astropy with useful background information and explanation.
+        of Solar Data Tools with useful background information and explanation.
 
         +++
 
         .. button-ref:: index_user_docs
-            :expand:
-            :color: primary
+            :ref-type: ref
             :click-parent:
+            :color: primary
+            :expand:
 
             To the user guide
 
-    .. grid-item-card::
-        :img-top: ../source/_static/index_images/contributor.svg
-
-        Contributor's Guide
-        ^^^^^^^^^^^^^^^^^^^
+    .. grid-item-card:: Contributor's Guide
+        :img-top: ../source/images/contributor.svg
+        :class-card: intro-card
+        :shadow: md
 
         Saw a typo in the documentation? Want to improve
         existing functionalities? The contributing guidelines will guide
-        you through the process of improving astropy.
+        you through the process of improving Solar Data Tools.
 
         +++
 
         .. button-ref:: index_dev
-            :expand:
-            :color: primary
+            :ref-type: ref
             :click-parent:
+            :color: primary
+            :expand:
 
             To the contributor's guide
 
-    .. grid-item-card::
-        :img-top: ../source/_static/index_images/api.svg
+    .. grid-item-card:: Project details
+        :img-top: ../source/images/api.svg
+        :class-card: intro-card
+        :shadow: md
 
-        Project details
-        ^^^^^^^^^^^^^^^
-
-        More details about the project (changelog and what's new pages).
+        More details about the project (technical details, changelog and what's new pages).
 
         +++
 
         .. button-ref:: index_project_details
-            :expand:
-            :color: primary
+            :ref-type: ref
             :click-parent:
+            :color: primary
+            :expand:
 
             To the project details
-
-
-Contents
-^^^^^^^^
-
-.. toctree::
-   :maxdepth: 4
-
-   setup
-   usage
-   modules
-   versioning
-   authors
-   license
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
-
-
-.. |PyPI release| image:: https://img.shields.io/pypi/v/solar-data-tools.svg
-   :target: https://pypi.org/project/solar-data-tools/
-.. |Anaconda Cloud release| image:: https://anaconda.org/slacgismo/solar-data-tools/badges/version.svg
-   :target: https://anaconda.org/slacgismo/solar-data-tools