]> git.ipfire.org Git - thirdparty/sqlalchemy/alembic.git/commitdiff
add cool github /pypi link stuff
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 19 Aug 2024 16:27:55 +0000 (12:27 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 19 Aug 2024 16:27:55 +0000 (12:27 -0400)
Change-Id: I57ec7a22a1d14992cc0f70d527a584a737022e21

docs/build/conf.py

index 859a9ef8405d69cd0edb1e11c57f209b3626e98b..549b6dd646d68cd38edda80898a4c61ecc293e88 100644 (file)
@@ -153,7 +153,27 @@ html_theme = "sphinx_book_theme"
 # further.  For a list of options available for each theme, see the
 # documentation.
 # NOTE: use nature_override.css, not this
-# html_theme_options = {}
+
+# mike got these just by copying from
+# https://github.com/executablebooks/sphinx-book-theme/blob/master/docs/conf.py#L103.
+# none of this seems to be clearly documented
+html_theme_options = {
+    "repository_url": "https://github.com/sqlalchemy/alembic",
+    "repository_branch": "main",
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/sqlalchemy/alembic",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/alembic/",
+            "icon": "https://img.shields.io/pypi/dw/alembic",
+            "type": "url",
+        },
+    ],
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []