diff --git a/docs/conf.py b/docs/conf.py index da4fb1b..b610885 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,17 @@ # These folders are copied to the documentation's HTML output html_static_path = ["../_static"] +html_theme_options = { + "announcement": """ + + This is an announcement! + + """, + "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 = [ @@ -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", diff --git a/docs/static/readme.txt b/docs/static/readme.txt new file mode 100644 index 0000000..df52a58 --- /dev/null +++ b/docs/static/readme.txt @@ -0,0 +1 @@ +you are here \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 12bd424..ad626e4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,6 +42,8 @@ dev = [ "types-requests", ] docs = [ + "furo", + "matplotlib", "myst-parser", "sphinx", "sphinx-copybutton",