docs: add project links to sidebar, header, and footer

empicano · Dec 6, 2022 · 23f4502 · 23f4502
1 parent e9a0c04
commit 23f4502
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,10 +16,26 @@
 extensions: list[str] = []
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+pygments_style = "default"
+pygments_dark_style = "dracula"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "furo"
 html_static_path = ["_static"]
 html_title = "asyncio-mqtt"
+html_theme_options = {
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/sbtinstruments/asyncio-mqtt",
+            "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": "",
+        },
+    ],
+}
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,9 @@
 The idiomatic asyncio MQTT Client 🙌
 ====================================
 
-Contents
---------
-
 .. toctree::
    :maxdepth: 2
+   :hidden:
    :caption: Contents:
 
    configuring-the-client
@@ -15,3 +13,13 @@ Contents
    listening-without-blocking
    tls
    proxying
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: Project links:
+
+   GitHub <https://github.com/sbtinstruments/asyncio-mqtt>
+   Issue tracker <https://github.com/sbtinstruments/asyncio-mqtt/issues>
+   Discussions <https://github.com/sbtinstruments/asyncio-mqtt/discussions>
+   PyPI <https://pypi.org/project/asyncio-mqtt/>