Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♻️ Docs: Comprehensive Documentation Updates #52

Merged
merged 4 commits into from
Jul 6, 2024
Merged

♻️ Docs: Comprehensive Documentation Updates #52

merged 4 commits into from
Jul 6, 2024

Conversation

abhiTronix
Copy link
Owner

@abhiTronix abhiTronix commented Jul 6, 2024

Brief Description

This pull request includes a series of updates and enhancements to the documentation and configuration settings.

Requirements / Checklist

  • I have read the DeFFcode PR Guidelines.
  • I have read the DeFFcode Documentation.
  • I have updated the documentation files accordingly(if required).

Related Issue

Context

These changes are part of an ongoing effort to enhance the documentation's accessibility, maintainability, and functionality.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

- ✨ 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`.
- 🔥 Removed Gitter community chat sidecard javascript.
- 🔥 Removed Twitter section from help and site metadata.
- 📝 Updated LinkenIn URL in `mkdocs.yml`.

Setup.py:
- 🔖 Added Python-3.11 to classifier metadata.
@abhiTronix abhiTronix added Documentation 📑 Improvements or additions to DeFFcode documentation. Enhancement ⚡ New feature Issue/Request enhancing DeFFcode APIs. WIP 🏗️ Work in Progress labels Jul 6, 2024
@abhiTronix abhiTronix added this to the v0.2.6 milestone Jul 6, 2024
@abhiTronix abhiTronix self-assigned this Jul 6, 2024
Copy link

codecov bot commented Jul 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.84%. Comparing base (84e8af1) to head (8d7f071).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #52   +/-   ##
=======================================
  Coverage   95.84%   95.84%           
=======================================
  Files           6        6           
  Lines         794      794           
=======================================
  Hits          761      761           
  Misses         33       33           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abhiTronix abhiTronix merged commit d448e1d into master Jul 6, 2024
14 checks passed
@abhiTronix abhiTronix deleted the dev branch July 6, 2024 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📑 Improvements or additions to DeFFcode documentation. Enhancement ⚡ New feature Issue/Request enhancing DeFFcode APIs. WIP 🏗️ Work in Progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant