updated docs template

Author: jchanvfx

.github/workflows/sphinx_doc_build.yml

@@ -9,7 +9,7 @@ on:
 env:
   # environment variables.
   SOURCE_BRANCH: main
-  GH_PAGES_BRANCH: gh-pages
+  PAGES_BRANCH: gh-pages
 
 jobs:
   docs-build:
@@ -44,7 +44,7 @@ jobs:
       # Merge the "main" branch to the "gh-pages" branch.
       - name: Update "gh-pages" branch
         run: |
-            git checkout $GH_PAGES_BRANCH
+            git checkout $PAGES_BRANCH
             git merge origin/$SOURCE_BRANCH
       # Build the sphinx api documentation.
       - name: Run Sphinx Build
@@ -55,4 +55,4 @@ jobs:
             git ls-files --others --exclude-standard
             git add ./api
             git commit -m "github action: auto build api docs"
-            git push origin $GH_PAGES_BRANCH
+            git push origin $PAGES_BRANCH

docs/_images/favicon.png

@@ -0,0 +1,8 @@
+<nav class="table w-full min-w-full my-6 lg:my-8">
+  <code style="font-size: 0.65rem;">Release - v{{ release }}</code>
+  {%- if theme_globaltoc_includehidden|tobool %}
+  {{ toctree(titles_only=true, collapse=False, includehidden=true) }}
+  {%- else %}
+  {{ toctree(titles_only=true, collapse=False) }}
+  {%- endif %}
+</nav>

docs/_images/logo.png

@@ -131,7 +131,7 @@
 # It should be a Windows-style icon file (.ico), which is 16x16 or 32x32
 # pixels large. Default: None.
 html_favicon = '_images/favicon.png'
-html_logo = '_images/favicon.png'
+html_logo = None
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
@@ -154,8 +154,8 @@
 # documentation.
 html_title = 'NodeGraphQt'
 html_theme_options = {
-    # "logo_light": "_images/logo.png",
-    # "logo_dark": "_images/logo.png"
+    'logo_light': '_images/favicon.png',
+    'logo_dark': '_images/favicon.png',
     'main_nav_links': {
         'Source': 'https://github.com/jchanvfx/NodeGraphQt',
         'Issues': 'https://github.com/jchanvfx/NodeGraphQt/issues',