DOC: Update to new sphinx theme.

ARM-DOE · Oct 21, 2024 · 184aaf0 · 184aaf0
1 parent 6633da9
commit 184aaf0
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 144 deletions.
diff --git a/docs/environment_docs.yml b/docs/environment_docs.yml
@@ -15,7 +15,6 @@ dependencies:
   - notebook
   - skyfield
   - scikit-posthocs
-  - pip
   - moviepy
   - cmweather
   - metpy
@@ -28,6 +27,7 @@ dependencies:
   - pydata-sphinx-theme
   - myst-nb
   - nbsphinx
+  - pip
   - pip:
     - mpl2nc
     - lazy_loader

diff --git a/docs/source/_static/act-theme.css b/docs/source/_static/act-theme.css
@@ -3,144 +3,47 @@
     font-family: Poppins, sans-serif;
   }
 
- /* ARM header color */
- .bg-arm {
-     background-color: #182b55;
- }
-
- :root {
-     --pst-color-navbar-link: 255, 255, 255;
-     --pst-color-text-base: 24, 43, 85;
-     --pst-color-h3: var(--pst-color-text-base);
-     --pst-color-h4: var(--pst-color-text-base);
-     --pst-color-h5: var(--pst-color-text-base);
-     --pst-color-h6: var(--pst-color-text-base);
-     --pst-color-paragraph: var(--pst-color-text-base);
- }
-
-/* Override the default color set in the original theme for title */
-.navbar-brand>.title {
-    color: rgba(255, 255, 255) !important;
-    font-weight: 400 !important;
-    font-style: bold;
+/* Define "ARM Blue" RGB values */
+:root {
+    --arm-blue-rgb: 18, 65, 117;
 }
 
- /* Override the default color set in the original theme */
- .navbar-nav>.active>.nav-link {
-     color: rgba(255, 255, 255) !important;
-     font-weight: 400 !important;
-     font-style: italic;
- }
-
- .fa-github-square:before {
-     color: rgba(255, 255, 255) !important;
-     font-weight: 400 !important;
- }
-
- .fa-twitter-square:before {
-     color: rgba(255, 255, 255) !important;
-     font-weight: 400 !important;
- }
-
- /* Override the default logo height */
- .navbar-brand {
-     height: 50px;
- }
-
- /* Enhance the links to function docs in the gallery examples */
- div[class^="highlight"] a {
-     background-color: #EEEEEE;
- }
-
- /* Control the appearance of the version alert banner */
- #banner .alert-version, .alert-news {
-     margin: 1em;
-     padding: 0.5em;
-     font-family: "Work Sans", sans-serif;
-     font-weight: 600; font-size: 16px;
- }
-
- .intro-card {
-     background: #d8e5e8;
-     border: none;
-     border-radius: 0;
-     padding: 30px 10px 10px 10px;
-     margin: 10px 0px;
- }
-
- .intro-card .card-text {
-     margin: 20px 0px;
- }
-
- .card-button {
-     background-color: #fafafa;
-     border: none;
-     color: #484848;
-     text-align: center;
-     text-decoration: none;
-     display: inline-block;
-     font-size: 0.9rem;
-     border-radius: 0.5rem;
-     max-width: 220px;
-     padding: 0.5rem 0rem;
-     margin-top: auto;
- }
-
- .card-button a {
-     color: #484848;
- }
-
- .card-button p {
-     margin-top: 0;
-     margin-bottom: 0rem;
-     color: #484848;
- }
-
- /* Tweaks to the appearance of the sidebars */
- .bd-sidebar {
-     flex: 0 0 20%;
-     border-right: none;
- }
-
- .bd-toc .tocsection {
-     border-left: none;
- }
-
- .bd-toc .section-nav {
-     border-left: none;
- }
-
- /* Can remove once theme releases new version */
- /* xarray output display in bootstrap */
- .xr-wrap[hidden] {
- display: block !important;
+ /* ARM header color */
+ .bg-header {
+     background: rgb(var(--arm-blue-rgb))
  }
 
- .xr-var-data pre {
-   border: none;
-   box-shadow: none;
- }
+ .theme-switch-button {
+    border-color: rgb(var(--arm-blue-rgb)) !important;
+}
 
+.bd-header .navbar-nav>.nav-item>.nav-link,
+.bd-header .dropdown-toggle,
 
- /* Styling the API Changes Table */
- .api-table tr:nth-child(3n + 1){
-     background: #EEF5F5;
- }
+ .navbar-nav .dropdown-menu {
+    background-color: var(--pst-color-background);
+}
 
- .api-table tr:nth-child(3n + 2){
-     opacity: 0.65;
- }
+/* Increase contrast of links in code snippets */
+div[class^="highlight"] a {
+    background-color: rgb(var(--arm-blue-rgb), 0.2);
+    color: var(--pst-color-text-muted);
+}
 
- code.literal:not(.xref) span.pre {
-     color: #000;
- }
+/* Control the appearance of the version alert banner */
+#banner .alert-version, .alert-news {
+    margin: 1em;
+    padding: 0.5em;
+    font-family: "Work Sans", sans-serif;
+    font-weight: 600; font-size: 16px;
+}
 
- .api-table tr:nth-child(3n + 2)>td span:first-child::before{
-     content: url(old.png);
-     zoom: 0.25;
- }
+/* Tweaks to the appearance of the sidebars */
+.bd-sidebar {
+    flex: 0 0 20%;
+    border-right: none;
+}
 
- .api-table tr:nth-child(3n + 3)>td span:first-child::before{
-     content: url(new.png);
-     zoom: 0.21;
- }
+.bd-sidebar-secondary div {
+    border-left: none;
+}
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -1,17 +1,7 @@
-{% extends "!layout.html" %}
+{% extends "pydata_sphinx_theme/layout.html" %}
 
 {% block fonts %}
 <style>
     @import url('https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,400;0,600;0,700;1,400;1,600;1,700&display=swap');
 </style>
-    {{ super() }}
-{% endblock %}
-
-{% block docs_navbar %}
-  <nav class="navbar navbar-dark navbar-expand-lg bg-arm fixed-top bd-navbar shadow" id="navbar-main">
-    {%- include "docs-navbar.html" %}
-  </nav>
-
-{# Added to support a banner with an alert #}
-    <div class="container-fluid" id="banner"></div>
 {% endblock %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -63,6 +63,7 @@
 autoclass_content = 'both'
 autosummary_generate = True
 autosummary_imported_members = True
+autodoc_typehints = "description"
 
 # Otherwise, the Return parameter list looks different from the Parameter list
 napoleon_use_rtype = False
@@ -84,7 +85,7 @@
 
 # General information about the project.
 project = 'Atmospheric data Community Toolkit'
-copyright = '2018-2022, ACT Developers'
+copyright = '2018-2024, ACT Developers'
 author = 'ACT Developers'
 
 # The version info for the project you're documenting, acts as replacement for