Added GitHub Buttons

Author: DenverCoder1

docs/source/_templates/__init__.py

@@ -1,7 +1,8 @@
 """
-Sphinx Read the Docs theme.
+This theme template is nearly entirely based on the Sphinx Read the Docs theme
+from https://github.com/ryan-roemer/sphinx-bootstrap-theme.
 
-From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
+Some minor modifications have been made to the template by Jonah Lawrence.
 """
 
 from os import path

docs/source/_templates/breadcrumbs.html

@@ -1,52 +1,71 @@
 {%- if meta is defined and meta is not none %}
-   {%- set check_meta = True %}
+{%- set check_meta = True %}
 {%- else %}
-   {%- set check_meta = False %}
+{%- set check_meta = False %}
 {%- endif %}
 
 {%- if check_meta and 'github_url' in meta %}
-   {%- set display_github = True %}
+{%- set display_github = True %}
 {%- endif %}
 
 {%- if check_meta and 'bitbucket_url' in meta %}
-   {%- set display_bitbucket = True %}
+{%- set display_bitbucket = True %}
 {%- endif %}
 
 {%- if check_meta and 'gitlab_url' in meta %}
-   {%- set display_gitlab = True %}
+{%- set display_gitlab = True %}
 {%- endif %}
 
+
 {%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
 
-{#- Translators: This is an ARIA section label for page links, including previous/next page link and links to GitHub/GitLab/etc. -#}
+{#- Translators: This is an ARIA section label for page links, including previous/next page link and links to
+GitHub/GitLab/etc. -#}
 <div role="navigation" aria-label="{{ _('Page navigation') }}">
   <ul class="wy-breadcrumbs">
     {%- block breadcrumbs %}
-      <li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> &raquo;</li>
-        {%- for doc in parents %}
-          <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
-        {%- endfor %}
-      <li>{{ title }}</li>
+    <li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> &raquo;</li>
+    {%- for doc in parents %}
+    <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
+    {%- endfor %}
+    <li>{{ title }}</li>
     {%- endblock %}
     {%- block breadcrumbs_aside %}
-      <li class="wy-breadcrumbs-aside">
-        {%- if hasdoc(pagename) and display_vcs_links %}
-          <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}" class="fa fa-github"> {{ _('View on GitHub') }}</a>
-        {%- endif %}
-      </li>
+    <li class="wy-breadcrumbs-aside">
+      {%- if hasdoc(pagename) and display_vcs_links %}
+      <!-- <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}" class="fa fa-github"> {{ _('View on GitHub') }}</a> -->
+      {%- endif %}
+      <!-- GitHub badges/links section -->
+      <div class="github">
+        <!-- GitHub Sponsors -->
+        <a class="github-button" href="https://github.com/sponsors/denvercoder1"
+          data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="octicon-heart"
+          data-size="large" aria-label="Sponsor @denvercoder1 on GitHub">Sponsor</a>
+        <!-- View on GitHub -->
+        <a class="github-button" href="https://github.com/denvercoder1/table2ascii"
+          data-color-scheme="no-preference: light; light: light; dark: dark;" data-size="large"
+          aria-label="View denvercoder1/table2ascii on GitHub">View on GitHub</a>
+        <!-- GitHub Star -->
+        <a class="github-button" href="https://github.com/denvercoder1/table2ascii"
+          data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="octicon-star" data-size="large"
+          data-show-count="true" aria-label="Star denvercoder1/table2ascii on GitHub">Star</a>
+      </div>
+    </li>
     {%- endblock %}
   </ul>
 
   {%- if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
   {#- Translators: This is an ARIA section label for sequential page links, such as previous and next page links. -#}
   <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{{ _('Sequential page navigation') }}">
-      {%- if prev %}
-        <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
-      {%- endif %}
-      {%- if next %}
-        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-      {%- endif %}
+    {%- if prev %}
+    <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}"
+      accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
+    {%- endif %}
+    {%- if next %}
+    <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}"
+      accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    {%- endif %}
   </div>
   {%- endif %}
-  <hr/>
-</div>
+  <hr />
+</div>

docs/source/_templates/layout.html

@@ -95,10 +95,11 @@
     {%- endfor %}
     {%- endif %}
     <script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
+    <!-- DarkReader - automatic dark mode -->
     <script src="https://cdn.jsdelivr.net/npm/darkreader@4.9.39/darkreader.min.js"></script>
-    <script>
-      DarkReader.auto();
-    </script>
+    <script>DarkReader.auto();</script>
+    <!-- GitHub Buttons -->
+    <script async defer src="https://buttons.github.io/buttons.js"></script>
 
     {#- OPENSEARCH #}
     {%- if use_opensearch %}