Skip to content

Commit

Permalink
Fix documentation theme configuration (#253)
Browse files Browse the repository at this point in the history
* fix docs theme config

* formatting
  • Loading branch information
kafitzgerald authored Nov 11, 2024
1 parent 649f33a commit a4cd369
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 23 deletions.
47 changes: 24 additions & 23 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,20 +212,30 @@ 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=
"<em>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.</em>",
)
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":
"<em>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.</em>",
}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
Expand All @@ -237,15 +247,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.
Expand Down
1 change: 1 addition & 0 deletions docs/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit a4cd369

Please sign in to comment.