From 184aaf0d1cff9018266ce5a6385a12129dcce8c5 Mon Sep 17 00:00:00 2001 From: zssherman Date: Mon, 21 Oct 2024 15:39:51 -0500 Subject: [PATCH] DOC: Update to new sphinx theme. --- docs/environment_docs.yml | 2 +- docs/source/_static/act-theme.css | 165 ++++++----------------------- docs/source/_templates/layout.html | 12 +-- docs/source/conf.py | 3 +- 4 files changed, 38 insertions(+), 144 deletions(-) diff --git a/docs/environment_docs.yml b/docs/environment_docs.yml index 5a65dedcce..9cbd286142 100644 --- 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 index 229041c598..e273fa1ace 100644 --- 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; +} \ No newline at end of file diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index a5e99e6b02..adb4e32d52 100644 --- 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 %} - {{ super() }} -{% endblock %} - -{% block docs_navbar %} - - -{# Added to support a banner with an alert #} - {% endblock %} diff --git a/docs/source/conf.py b/docs/source/conf.py index d04bc24fb6..c27f0bab3a 100644 --- 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