From a8e50d3c9211fcff0cc298073a2c4339182bf70b Mon Sep 17 00:00:00 2001
From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com>
Date: Fri, 8 Nov 2024 13:16:11 -0700
Subject: [PATCH 1/2] fix docs theme config
---
docs/conf.py | 38 +++++++++++++++-----------------------
docs/release-notes.rst | 1 +
2 files changed, 16 insertions(+), 23 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index 4a2eaf4..b943dff 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -212,20 +212,21 @@ def __getattr__(cls, name):
# 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 = dict(
- # analytics_id='' this is configured in rtfd.io
- # canonical_url="",
- repository_url="https://github.com/NCAR/geocat-viz",
- repository_branch="main",
- path_to_docs="docs",
- use_edit_page_button=True,
- use_repository_button=True,
- use_issues_button=True,
- home_page_in_toc=False,
- navbar_footer_text="",
- extra_footer=
- "This material is based upon work supported by the NSF National Center for Atmospheric Research, a major facility sponsored by the U.S. National Science Foundation and managed by the University Corporation for Atmospheric Research. Any opinions, findings and conclusions or recommendations expressed in this material do not necessarily reflect the views of the U.S. National Science Foundation.",
-)
+html_theme_options = {
+ "repository_url": "https://github.com/NCAR/geocat-viz",
+ "repository_branch": "main",
+ "path_to_docs": "docs",
+ "use_edit_page_button": True,
+ "use_repository_button": True,
+ "use_issues_button": True,
+ "home_page_in_toc": False,
+ "navbar_footer_text": "",
+ "logo": {
+ "image_light": '_static/images/logos/NSF_NCAR_light.svg',
+ "image_dark": '_static/images/logos/NSF_NCAR_dark.svg',
+ },
+ "extra_footer": "This material is based upon work supported by the NSF National Center for Atmospheric Research, a major facility sponsored by the U.S. National Science Foundation and managed by the University Corporation for Atmospheric Research. Any opinions, findings and conclusions or recommendations expressed in this material do not necessarily reflect the views of the U.S. National Science Foundation.",
+}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
@@ -237,15 +238,6 @@ def __getattr__(cls, name):
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-html_theme_options = {
- "logo": {
- "image_light": '_static/images/logos/NSF_NCAR_light.svg',
- "image_dark": '_static/images/logos/NSF_NCAR_dark.svg',
- }
-}
-
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 5c3ead4..d9b2eba 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -11,6 +11,7 @@ v2024.xx.0 (unreleased)
Documentation
^^^^^^^^^^^^^
* Remove link to broken NCL_vector_5.py example by `Katelyn FitzGerald`_ in (pr::`249`)
+* Fix documentation theme configuration by `Katelyn FitzGerald`_ in (pr::`253`)
Internal Changes
^^^^^^^^^^^^^^^^
From bac0220d1cbb292b3cd485e8f0d59efe7408429b Mon Sep 17 00:00:00 2001
From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com>
Date: Fri, 8 Nov 2024 13:16:40 -0700
Subject: [PATCH 2/2] formatting
---
docs/conf.py | 27 ++++++++++++++++++---------
1 file changed, 18 insertions(+), 9 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index b943dff..fa0e53f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -213,19 +213,28 @@ def __getattr__(cls, name):
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
- "repository_url": "https://github.com/NCAR/geocat-viz",
- "repository_branch": "main",
- "path_to_docs": "docs",
- "use_edit_page_button": True,
- "use_repository_button": True,
- "use_issues_button": True,
- "home_page_in_toc": False,
- "navbar_footer_text": "",
+ "repository_url":
+ "https://github.com/NCAR/geocat-viz",
+ "repository_branch":
+ "main",
+ "path_to_docs":
+ "docs",
+ "use_edit_page_button":
+ True,
+ "use_repository_button":
+ True,
+ "use_issues_button":
+ True,
+ "home_page_in_toc":
+ False,
+ "navbar_footer_text":
+ "",
"logo": {
"image_light": '_static/images/logos/NSF_NCAR_light.svg',
"image_dark": '_static/images/logos/NSF_NCAR_dark.svg',
},
- "extra_footer": "This material is based upon work supported by the NSF National Center for Atmospheric Research, a major facility sponsored by the U.S. National Science Foundation and managed by the University Corporation for Atmospheric Research. Any opinions, findings and conclusions or recommendations expressed in this material do not necessarily reflect the views of the U.S. National Science Foundation.",
+ "extra_footer":
+ "This material is based upon work supported by the NSF National Center for Atmospheric Research, a major facility sponsored by the U.S. National Science Foundation and managed by the University Corporation for Atmospheric Research. Any opinions, findings and conclusions or recommendations expressed in this material do not necessarily reflect the views of the U.S. National Science Foundation.",
}
# Add any paths that contain custom themes here, relative to this directory.