♻️ Docs: Comprehensive Documentation Updates [#52]

- ✨ Added new `tables` markdown extension for improved table formatting. - ♿️ Set the default version of the documentation to 'latest'. - 🚩 Introduced new features related to `navigation`, `content`, and `toc`. - 📝 Set `edit_uri` for GitHub edit links to facilitate easier contributions. - 🩹 Replaced deprecated `materialx` with supported `extensions` emoji generator. - 💄 Enhanced the active tab fonts with `font-weight: bold` in `custom.css`. - 🔥 Removed deprecated Gitter community chat sidecard. - 📝 Updated LinkedIn URL in `mkdocs.yml`. - 🔥 Removed Twitter section from help and site metadata. - 🚚 Migrated to Google Analytics 4 in `mkdocs.yml`. - 🚩 Added `line_spans: __span` and `pygments_lang_class: true` parameters to `pymdownx.highlight` markdown extension. - 🚩 Enabled `normalize_issue_symbols: true` in `pymdownx.magiclink` markdown extension. -💸 Included GitHub sponsors in `FUNDING.yml`. Setup.py: - 🔖 Added Python-3.11 to setup.py classifier metadata.
abhiTronix · Jul 6, 2024 · d448e1d · d448e1d
2 parents 84e8af1 + 8d7f071
commit d448e1d
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 66 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1 +1,2 @@
-ko_fi: abhitronix
+ko_fi: abhitronix
+github: abhiTronix
diff --git a/docs/help.md b/docs/help.md
@@ -58,17 +58,6 @@ You can try helping solving those issues, or give valuable feedback/review on ne
 &thinsp; 
 
 
-## :material-twitter: Tweet about DeFFcode
-
-Tweet about DeFFcode and Spread the word 🗣:
-
-<a href="https://twitter.com/intent/tweet?button_hashtag=deffcode&ref_src=twsrc%5Etfw" class="twitter-hashtag-button" data-size="large" data-text="Checkout DeFFcode - A High-performance Real-time Video frames Generator for generating blazingly fast video frames in python." data-url="https://abhitronix.github.io/deffcode" data-related="abhi_una12" data-show-count="false">Tweet #deffcode</a><script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
-
-Let others know how you are using DeFFcode and why you like it!
-
-&thinsp; 
-
-
 ## :fontawesome-solid-gift: Helping Author
 
 > Donations help keep DeFFcode's development alive and motivate me _(as author)_. :heart:{ .heart }
@@ -90,7 +79,6 @@ You can connect with me, the author 👋:
 ![Author Image](https://avatars.githubusercontent.com/u/34266896?v=4){ align=left width="160" loading=lazy }
 
 * Follow author on GitHub: [![GitHub follow](https://img.shields.io/github/followers/abhiTronix?label=Follow%20%40abhiTronix&logo=github&style=flat-square)](https://github.com/abhiTronix)
-* Follow author on Twitter: <a href="https://twitter.com/abhi_una12?ref_src=twsrc%5Etfw" class="twitter-follow-button" data-show-count="false">Follow &commat;abhi_una12</a>
 * Get in touch with author on Linkedin: [![Linkedin follow](https://img.shields.io/badge/Follow-&commat;Abhishek&thinsp;Thakur-orange.svg?logo=linkedin&style=flat-square)](https://in.linkedin.com/in/abhishek-abhitronix?trk=profile-badge)
 
 <!-- Place this tag in your head or just before your close body tag. -->

diff --git a/docs/overrides/assets/javascripts/extra.js b/docs/overrides/assets/javascripts/extra.js
@@ -1,4 +1,4 @@
-/* 
+/*
 ===============================================
 DeFFcode library source-code is deployed under the Apache 2.0 License:
 
@@ -18,7 +18,4 @@ limitations under the License.
 ===============================================
 */
 
-// gitter sidecard
-((window.gitter = {}).chat = {}).options = {
-  room: 'deffcode-python/community'
-};
+// empty
diff --git a/docs/overrides/assets/stylesheets/custom.css b/docs/overrides/assets/stylesheets/custom.css
@@ -236,6 +236,10 @@ limitations under the License.
 	width: 90%;
 }
 
+.md-tabs__item--active {
+	font-weight: bold;
+}
+
 .md-tabs__link--active {
 	font-weight: bold;
 }

diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -1,55 +1,48 @@
 {% extends "base.html" %}
 {% block extrahead %}
-  {% set title = config.site_name %}
-  {% if page and page.meta and page.meta.title %}
-    {% set title = title ~ " - " ~ page.meta.title %}
-  {% elif page and page.title and not page.is_homepage %}
-    {% set title = title ~ " - " ~ page.title | striptags %}
-  {% endif %}
-  {% set image = config.site_url ~ '/assets/images/decode-banner.png' %}
-  <meta property="og:type" content="website">
-  <meta property="og:title" content="{{ title }}">
-  <meta property="og:description" content="{{ config.site_description }}">
-  <meta property="og:url" content="{{ page.canonical_url }}">
-  <meta property="og:image" content="{{ image }}">
-  <meta property="og:image:type" content="image/png">
-  <meta property="og:image:width" content="1200">
-  <meta property="og:image:height" content="630">
-  <meta name="twitter:card" content="summary_large_image">
-  <meta name="twitter:site" content="@abhi_una12">
-  <meta name="twitter:creator" content="@abhi_una12">
-  <meta name="twitter:title" content="{{ title }}">
-  <meta name="twitter:description" content="{{ config.site_description }}">
-  <meta name="twitter:image" content="{{ image }}">
+{% set title = config.site_name %}
+{% if page and page.meta and page.meta.title %}
+{% set title = title ~ " - " ~ page.meta.title %}
+{% elif page and page.title and not page.is_homepage %}
+{% set title = title ~ " - " ~ page.title | striptags %}
+{% endif %}
+{% set image = config.site_url ~ '/assets/images/decode-banner.png' %}
+<meta property="og:type" content="website">
+<meta property="og:title" content="{{ title }}">
+<meta property="og:description" content="{{ config.site_description }}">
+<meta property="og:url" content="{{ page.canonical_url }}">
+<meta property="og:image" content="{{ image }}">
+<meta property="og:image:type" content="image/png">
+<meta property="og:image:width" content="1200">
+<meta property="og:image:height" content="630">
 {% endblock %}
 {% block announce %}
-  <!-- Add announcement here, including arbitrary HTML -->
-  {% set announcement_link = config.site_url ~ '/recipes/basic/decode-camera-devices/#decoding-camera-devices-using-indexes' %}
+<!-- Add announcement here, including arbitrary HTML -->
+{% set announcement_link = config.site_url ~
+'/recipes/basic/decode-camera-devices/#decoding-camera-devices-using-indexes' %}
 
-  <b>Hey, Index based Camera Device Capture support has been added in <code>v0.2.4</code>. Checkout these <a href="{{ announcement_link }}">new recipes <span class="twemoji"> {% include ".icons/material/pot-steam-outline.svg" %} </span> ➶</a></b>
+<b>Hey, Index based Camera Device Capture support has been added in <code>v0.2.4</code>. Checkout these <a
+    href="{{ announcement_link }}">new recipes <span class="twemoji"> {% include ".icons/material/pot-steam-outline.svg"
+      %} </span> ➶</a></b>
 {% endblock %}
 {% block outdated %}
-  You're not viewing the latest version.
-  <a href="{{ '../' ~ base_url }}">
-    <strong>Click here to go to latest.</strong>
-  </a>
+You're not viewing the latest version.
+<a href="{{ '../' ~ base_url }}">
+  <strong>Click here to go to latest.</strong>
+</a>
 {% endblock %}
 {% block content %}
-  {{ super() }}
-  <footer class="sponsorship">
-    <hr>
-    <a href="https://ko-fi.com/W7W8WTYO">
-      <span class="twemoji heart-throb-hover">
-        <img alt="❤" class="twemoji heart" src="https://twemoji.maxcdn.com/v/latest/svg/2764.svg" title="Donate">
-      </span>
-    </a>
-    <hr>
-  </footer>
-{% endblock %}
-{% block libs %}
-  <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
+{{ super() }}
+<footer class="sponsorship">
+  <hr>
+  <a href="https://ko-fi.com/W7W8WTYO">
+    <span class="twemoji heart-throb-hover">
+      <img alt="❤" class="twemoji heart" src="https://twemoji.maxcdn.com/v/latest/svg/2764.svg" title="Donate">
+    </span>
+  </a>
+  <hr>
+</footer>
 {% endblock %}
-
 <!--
 ===============================================
 DeFFcode library source-code is deployed under the Apache 2.0 License:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,7 +22,7 @@ site_description: >-
 # Repository
 repo_name: abhiTronix/deffcode
 repo_url: https://github.com/abhiTronix/deffcode
-edit_uri: ""
+edit_uri: edit/master/docs/
 
 # Copyright
 copyright: Copyright &copy; 2021 Abhishek Thakur(@abhiTronix)
@@ -35,16 +35,23 @@ theme:
   # Default values, taken from mkdocs_theme.yml
   language: en
   features:
-    - navigation.tracking
+    - announce.dismiss
     - navigation.tabs
+    - navigation.tabs.sticky
     - navigation.indexes
     - navigation.top
+    - navigation.tracking
     - search.suggest
     - search.highlight
     - search.share
     - content.code.annotate
     - content.code.copy
     - content.tabs.link
+    - content.footnote.tooltips
+    - content.action.view
+    - content.action.edit
+    - content.tooltips
+    - toc.follow
   palette:
     # Light mode
     - media: "(prefers-color-scheme: light)"
@@ -99,14 +106,15 @@ extra:
     - icon: fontawesome/brands/gitter
       link: https://gitter.im/deffcode-python/community
     - icon: fontawesome/brands/linkedin
-      link: https://www.linkedin.com/in/abhishek-singh-thakur-a37845a5
+      link: https://www.linkedin.com/in/abhishek-abhitronix/
     - icon: fontawesome/brands/dev
       link: https://dev.to/abhitronix
   version:
     provider: mike
+    default: latest
   analytics: # Google analytics
     provider: google
-    property: UA-131929464-1
+    property: G-XMZCQ3KBNJ
 extra_css:
   - assets/stylesheets/custom.css
 extra_javascript:
@@ -120,6 +128,7 @@ validation:
 markdown_extensions:
   - admonition
   - abbr
+  - tables
   - attr_list
   - def_list
   - footnotes
@@ -137,13 +146,16 @@ markdown_extensions:
   - pymdownx.critic
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.inlinehilite
   - pymdownx.highlight:
       anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
   - pymdownx.keys
   - pymdownx.magiclink:
+      normalize_issue_symbols: true
       repo_url_shorthand: true
       user: abhiTronix
       repo: deffcode

diff --git a/setup.py b/setup.py
@@ -94,6 +94,7 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
     ],
     python_requires=">=3.7",
     scripts=[],