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

Add HUB-SDK docs #7775

Merged
merged 14 commits into from Jan 23, 2024
Merged

Add HUB-SDK docs #7775

merged 14 commits into from Jan 23, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 23, 2024

@kalenmike @hassaanfarooq01 @sergiuwaxmann

Pending ultralytics/hub-sdk#88 merging first.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Ultralytics removes language translation support and enhances documentation infrastructure for better maintainability and localization.

πŸ“Š Key Changes

  • πŸ’Ό Workflow Adjustments: Removed Weglot translation support from the GitHub workflow.
  • πŸ›  Documentation Infrastructure: Added new 'Under Construction' placeholder pages and improved support for Ultralytics HUB SDK documentation.
  • πŸ“– Improved Doc Generation: Updated the docs build process, including cloning & updating the hub-sdk repository and handling document localization better.
  • πŸ”— Link Fixes: Corrected links to renamed inference-api.md and updated the main navigation structure within MkDocs.
  • πŸ”§ Code Tidying: Removed unnecessary LANGUAGES toggle and included necessary script adjustments to remove deprecated features.

🎯 Purpose & Impact

  • πŸ— Build process enhancement allows for more streamlined updates and management of the Ultralytics HUB SDK documentation.
  • 🧩 Removal of Weglot key support is likely to streamline the build process, but may indicate a change in how translations will be handled in the future.
  • 🧰 Users will now see an 'Under Construction' placeholder for upcoming features, allowing anticipation of new releases while maintaining a clean documentation structure.
  • πŸ” Corrected links and updated MkDocs navigation will provide users with an improved browsing experience and better resource discovery.
  • 🧹 Code cleanup improves maintainability of the project by removing obsolete code and potentially reducing build complexity.

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Comparison is base (67ae86f) 39.45% compared to head (9703091) 39.43%.

❗ Current head 9703091 differs from pull request most recent head e46e271. Consider uploading reports for the commit e46e271 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7775      +/-   ##
==========================================
- Coverage   39.45%   39.43%   -0.02%     
==========================================
  Files         117      117              
  Lines       14392    14392              
==========================================
- Hits         5678     5676       -2     
- Misses       8714     8716       +2     
Flag Coverage Ξ”
GPU 39.43% <100.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

glenn-jocher and others added 10 commits January 23, 2024 14:46
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher changed the title Update HUB docs Add HUB-SDK docs Jan 23, 2024
@glenn-jocher glenn-jocher merged commit 1152a06 into main Jan 23, 2024
8 checks passed
@glenn-jocher glenn-jocher deleted the build_docs branch January 23, 2024 17:58
hmurari pushed a commit to hmurari/ultralytics that referenced this pull request Apr 17, 2024
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: Laughing <61612323+Laughing-q@users.noreply.github.com>
Co-authored-by: Muhammad Rizwan Munawar <chr043416@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants