Skip to content

Commit

Permalink
Add new theme
Browse files Browse the repository at this point in the history
  • Loading branch information
bsweger committed Oct 8, 2024
1 parent 077d95d commit e51b5ed
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
25 changes: 23 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@

# These folders are copied to the documentation's HTML output
html_static_path = ["../_static"]
html_theme_options = {
"announcement": """
<a style=\"text-decoration: none; color: white;\"
href=\"https://reichlab.io">
<img src=\"/en/latest/_static/reichlab.png\"/> This is an announcement!
</a>
""",
"sidebar_hide_name": True,
"light_logo": "banner.svg",
"dark_logo": "dark-logo.svg",
}

# from https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
myst_enable_extensions = [
Expand All @@ -43,10 +54,20 @@
"attrs_inline",
]

# Open Graph metadata
ogp_title = "cladetime documentation"
ogp_type = "website"
ogp_social_cards = {"image": "images/reichlab.png", "line_color": "#F09837"}
ogp_description = "cladetime is a user-friendly library for accessing Sars-Cov-2 clade data from Nextstrain."

# Test code blocks only when explicitly specified
doctest_test_doctest_blocks = ""

# -- Options for HTML output

html_theme = "sphinx_book_theme"
# html_logo = "images/LOGO-hubverse-withtext.png"
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "furo"
html_favicon = "images/reichlab.png"
html_title = "Cladetime"
html_theme_options = {
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ dev = [
"types-requests",
]
docs = [
"furo",
"myst-parser",
"sphinx",
"sphinx-copybutton",
Expand Down

0 comments on commit e51b5ed

Please sign in to comment.