Skip to content

Commit

Permalink
Clean up sphinx config
Browse files Browse the repository at this point in the history
  • Loading branch information
bsweger committed Oct 11, 2024
1 parent df86eaf commit 1d76d62
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 23 deletions.
Binary file added docs/_static/cladetime_logo dark_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/cladetime_logo_light_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/reichlab_favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 18 additions & 23 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
import os
import sys
from datetime import date

# Configuration file for the Sphinx documentation builder.

# -- Project information

project = "Cladetime"
copyright = f"{date.today().year}, Reich Lab @ The University of Massachusetts Amherst"
project_copyright = "%Y, Reich Lab @ The University of Massachusetts Amherst"
author = "Reich Lab"

# Add cladetime location to the path, so we can use autodoc to
Expand All @@ -19,7 +18,6 @@
# FIXME: get the version dynamically
version = "0.1.0"


# -- General configuration

extensions = [
Expand All @@ -32,6 +30,9 @@
"sphinx.ext.napoleon",
]

# Warn about all references to unknown targets
nitpicky = True

intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"sphinx": ("https://www.sphinx-doc.org/en/master/", None),
Expand All @@ -40,12 +41,22 @@

templates_path = ["_templates"]

# The root toctree document.
# root_doc = "index"

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

# Only look for source files in the docs directory
include_patterns = ["**/docs"]

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_static_path = ["_static"]
html_theme = "furo"
html_favicon = "images/reichlab.png"
html_favicon = "_static/reichlab_favicon.png"
html_title = "Cladetime"
html_last_updated_fmt = "%Y-%m-%d"

# These folders are copied to the documentation's HTML output
html_theme_options = {
Expand All @@ -55,24 +66,12 @@
This is an announcement!
</a>
""",
"light_logo": "reichlab.png",
"dark_logo": "reichlab.png",
"sidebar_hide_name": True,
"light_logo": "cladetime_logo_light_mode.png",
"dark_logo": "cladetime_logo_dark_mode.png",
"navigation_with_keys": True,
}

# Order sidebar content, placing ads in the left sidebar
# html_sidebars = {
# "**": [
# "sidebar/brand.html",
# "sidebar/search.html",
# "sidebar/scroll-start.html",
# "sidebar/navigation.html",
# "sidebar/scroll-end.html",
# "sidebar/ethical-ads.html",
# ]
# }


# from https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
myst_enable_extensions = [
"amsmath",
Expand All @@ -91,9 +90,5 @@
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 EPUB output
epub_show_urls = "footnote"
Binary file removed docs/images/reichlab.png
Binary file not shown.

0 comments on commit 1d76d62

Please sign in to comment.