Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation theme configuration #253

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Fix documentation theme configuration #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8e50d3
fix docs theme config
kafitzgerald Nov 8, 2024
bac0220
formatting
kafitzgerald Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 24 additions & 23 deletions docs/conf.py
View file
Open in desktop
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
View file
Open in desktop
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
Loading