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 210d37e
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 13 deletions.
37 changes: 24 additions & 13 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,23 +54,23 @@
"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 = {
"home_page_in_toc": True,
"repository_url": "https://github.com/reichlab/cladetime",
"repository_branch": "main",
"path_to_docs": "docs",
"use_repository_button": True,
# "use_edit_page_button": True,
"use_issues_button": True,
# "use_sidenotes": True,
# "navbar_persistent": ["theme-switcher", "navbar-icon-links"],
}
html_theme_options = {}

# html_js_files = [
# "js/custom.js",
Expand Down
1 change: 1 addition & 0 deletions docs/static/readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
you are here
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ dev = [
"types-requests",
]
docs = [
"furo",
"matplotlib",
"myst-parser",
"sphinx",
"sphinx-copybutton",
Expand Down

0 comments on commit 210d37e

Please sign in to comment.