Add GitHub link and try to fix open graph cards

reichlab · Oct 11, 2024 · 83369fd · 83369fd
1 parent 102f6fa
commit 83369fd
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 13 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -78,14 +78,20 @@
     "dark_logo": "cladetime_logo_dark_mode.png",
     "navigation_with_keys": True,
     "source_repository": "https://github.com/reichlab/cladetime/",
-}
-
-html_context = {
-    # Enable the "Edit in GitHub link within the header of each page.
-    "display_github": True,
-    "github_user": "reichlab",
-    "github_repo": "cladetime",
-    "github_version": "main/source/",
+    # source for GitHub footer icon:
+    # https://pradyunsg.me/furo/customisation/footer/#using-embedded-svgs
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/reichlab/cladetime",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
 }
 
 # from https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
@@ -101,10 +107,14 @@
 ]
 
 # Open Graph metadata
+ogp_site_url = "https://cladetime.readthedocs.io"
 ogp_title = "cladetime documentation"
 ogp_type = "website"
-ogp_social_cards = {"image": "_static/cladetime_logo_light_mode.png", "line_color": "#F09837"}
-ogp_description = "Cladetime is a Python interface for accessing Nextstraing Sars-Cov-2 sequence and clade data."
+ogp_image = "https://cladetime.readthedocs.io/en/latest/_static/cladetime_logo_light_mode.png"
+ogp_social_cards = {
+    "image": "https://cladetime.readthedocs.io/en/latest/_static/cladetime_logo_light_mode.png",
+    "line_color": "#5d9c9c",
+}
 
 # Warn about all references to unknown targets
 nitpicky = True

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,9 +1,10 @@
+:og:description: Cladetime is a Python interface for accessing Sars-Cov-2 sequence and clade data provided by Nextstrain.
+
 ===============
  Cladetime
 ===============
 
-Cladetime is a Python library for manipulating SARS-CoV-2 sequence and clade data provided by
-`nextstrain.org <https://nextstrain.org/>`_.
+Cladetime is a Python interface for accessing `Nextstrain <https://nextstrain.org/>`_ Sars-Cov-2 sequence and clade data.
 
 .. toctree::
    :titlesonly:
@@ -44,7 +45,7 @@ daily workflow pipeline.
    ...        pl.col("host") == "Homo sapiens",
    ...    )
    ...    .cast({"date": pl.Date}, strict=False)
-   ...)
+   ... )
 
    >>> filtered_sequence_metadata.head(5).collect()
 

diff --git a/docs/reference/cladetime.rst b/docs/reference/cladetime.rst
@@ -1,3 +1,5 @@
+:og:description: Cladetime is a Python interface for accessing Sars-Cov-2 sequence and clade data provided by Nextstrain.
+
 ==========
 CladeTime
 ==========