Update: bip38 documentation & add logo

talonlab · Dec 1, 2024 · 0dde52d · 0dde52d
1 parent d942af5
commit 0dde52d
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "BIP38"
-copyright = f"{datetime.datetime.now().year}, {__author__}"
+copyright = f"2023-{datetime.datetime.now().year}, {__author__}"
 author = __author__
 
 # The full version, including alpha/beta/rc tags
@@ -55,7 +55,7 @@
 # a list of builtin themes.
 html_theme = "furo"
 # Product logo name
-# html_logo = "static/png/hdwallet.png"
+html_logo = "static/svg/bip38-logo.svg"
 # Theme options
 html_theme_options = {
     # "canonical_url": "",
@@ -88,6 +88,9 @@
     # "announcement": "<em>Import</em> announcement!",
 }
 
+# Set a minimal HTML title
+html_title = release
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

diff --git a/docs/cryptocurrencies.rst b/docs/cryptocurrencies.rst
@@ -1,8 +1,8 @@
 :orphan:
 
-==========================
-Supported Cryptocurrencies
-==========================
+================
+Cryptocurrencies
+================
 
 This module supports more than 150+ cryptocurrencies, including the following:
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -489,6 +489,7 @@ Buy me a coffee if You found this tool helpful:
 
 - **Bitcoin** - 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS
 - **Ethereum / Tether** - 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B
+- **Solana** - 9cVoan5GvnpVvysEkFWEFR4k9cpTdWKmqQ6Gi7nwM5ES
 
 Thank you very much for your support.
 

diff --git a/docs/static/css/bip38.css b/docs/static/css/bip38.css
@@ -15,3 +15,13 @@ td, th {
 .name {
     text-align: left;
 }
+
+.sidebar-logo-container img {
+    width: 100px;
+    height: auto;
+}
+
+.sidebar-brand-text {
+    text-align: center;
+    font-size: 19px;
+}
diff --git a/docs/static/gif/bip38.gif b/docs/static/gif/bip38.gif
diff --git a/docs/static/svg/bip38-full.svg b/docs/static/svg/bip38-full.svg
diff --git a/docs/static/svg/bip38.svg → docs/static/svg/bip38-logo.svg b/docs/static/svg/bip38.svg → docs/static/svg/bip38-logo.svg
diff --git a/docs/toctree.rst b/docs/toctree.rst
@@ -6,7 +6,7 @@ BIP38
     :maxdepth: 3
 
     Overview <index.rst>
-    Cryptocurrencies <cryptocurrencies.rst>
+    Supported Cryptocurrencies <cryptocurrencies.rst>
 
 .. toctree::
     :maxdepth: 3