Add icons to docs.

wildboar-foundation · Feb 2, 2024 · 87501fc · 87501fc
1 parent 9ae4b45
commit 87501fc
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/docs/_static/js/fa.js b/docs/_static/js/fa.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -114,6 +114,20 @@ def get_current_branch():
         "version_match": "dev" if current_branch_name == "master" else version,
     },
     "check_switcher": False,
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/wildboar-foundation/wildboar/",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/wildboar/",
+            "icon": "fa-custom fa-pypi",
+        },
+    ],
+    "navigation_with_keys": False,
 }
 
 html_context = {
@@ -125,6 +139,7 @@ def get_current_branch():
     "css/custom.css",
     "css/pygments-override.css",
 ]
+html_js_files = ["js/fa.js"]
 
 rst_prolog = """
 .. role:: python(code)