From 4c121a1f3d9c83ee2299af7bb4376b2156e90afa Mon Sep 17 00:00:00 2001 From: abhiTronix Date: Sat, 6 Jul 2024 08:08:59 +0530 Subject: [PATCH 1/4] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Docs:=20Refactored=20d?= =?UTF-8?q?ocumentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - ✨ Added new `tables` markdown extension. - ♿️ Set the default version to 'latest'. - 🚚 Migrated to new Google Analytics 4 in mkdocs.yml. - 🚩 Added new `navigation`, `content` and `toc` related features. - 🩹 Replace depreciated `materialx` with supported `extensions` emoji generator. - 📝 Set edit_uri for GitHub edit links - 🚩 Added `line_spans: __span` and `pygments_lang_class: true` parameters to `pymdownx.highlight` markdown extension. - 🚩 Added `normalize_issue_symbols: true` to `pymdownx.magiclink` markdown extension. - ✨ Added new `tables` markdown extension. - 💄 Added `font-weight: bold` to active tab fonts in `custom.css`. --- docs/overrides/assets/stylesheets/custom.css | 4 ++++ mkdocs.yml | 22 +++++++++++++++----- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/docs/overrides/assets/stylesheets/custom.css b/docs/overrides/assets/stylesheets/custom.css index dfdd29d..dd42503 100644 --- 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/mkdocs.yml b/mkdocs.yml index 98bc4ef..a4c6573 100644 --- 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 © 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)" @@ -104,9 +111,10 @@ extra: 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 From 68c69b6b037a90d0ef1e44001e55f658182ccf0a Mon Sep 17 00:00:00 2001 From: abhiTronix Date: Sat, 6 Jul 2024 08:13:23 +0530 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=93=9D=20Docs:=20Removed=20deprecated?= =?UTF-8?q?=20Gitter=20community=20chat=20sidecard.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 🔥 Removed Gitter community chat sidecard javascript. --- docs/overrides/assets/javascripts/extra.js | 7 +- docs/overrides/main.html | 83 +++++++++++----------- 2 files changed, 43 insertions(+), 47 deletions(-) diff --git a/docs/overrides/assets/javascripts/extra.js b/docs/overrides/assets/javascripts/extra.js index 6f542ca..4699986 100644 --- 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' -}; \ No newline at end of file +// empty \ No newline at end of file diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 904dac6..9e5cb2c 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,55 +1,54 @@ {% 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' %} - - - - - - - - - - - - - - +{% 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' %} + + + + + + + + + + + + + + {% endblock %} {% block announce %} - - {% set announcement_link = config.site_url ~ '/recipes/basic/decode-camera-devices/#decoding-camera-devices-using-indexes' %} + +{% set announcement_link = config.site_url ~ +'/recipes/basic/decode-camera-devices/#decoding-camera-devices-using-indexes' %} - Hey, Index based Camera Device Capture support has been added in v0.2.4. Checkout these new recipes {% include ".icons/material/pot-steam-outline.svg" %} ➶ +Hey, Index based Camera Device Capture support has been added in v0.2.4. Checkout these new recipes {% include ".icons/material/pot-steam-outline.svg" + %} ➶ {% endblock %} {% block outdated %} - You're not viewing the latest version. - - Click here to go to latest. - +You're not viewing the latest version. + + Click here to go to latest. + {% endblock %} {% block content %} - {{ super() }} - -{% endblock %} -{% block libs %} - +{{ super() }} + {% endblock %} - diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 9e5cb2c..910935b 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -15,12 +15,6 @@ - - - - - - {% endblock %} {% block announce %} diff --git a/mkdocs.yml b/mkdocs.yml index a4c6573..92f1bf2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -106,7 +106,7 @@ 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: diff --git a/setup.py b/setup.py index d2b486d..1a58f7f 100644 --- 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=[], From 8d7f071f881bfb3dabda3212a529badf6c92f202 Mon Sep 17 00:00:00 2001 From: abhiTronix Date: Sat, 6 Jul 2024 08:43:33 +0530 Subject: [PATCH 4/4] =?UTF-8?q?=F0=9F=92=B8=20Maintenance:=20Added=20GitHu?= =?UTF-8?q?b=20sponsors=20in=20FUNDING.yml.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/FUNDING.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index baf39b3..970fe1c 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1,2 @@ -ko_fi: abhitronix \ No newline at end of file +ko_fi: abhitronix +github: abhiTronix