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

Fix doc build on docs.rs #1168

Merged
merged 1 commit into from Jan 23, 2024
Merged

Fix doc build on docs.rs #1168

merged 1 commit into from Jan 23, 2024

Conversation

syl20bnr
Copy link
Member

@syl20bnr syl20bnr commented Jan 23, 2024

Should fix #1141

Unfortunately I was not able to test it properly because the docs.rs documentation is very sparse and I encountered several obstacles (even in an Ubuntu VM). I'll try to make it work before the release if I can get good support on zulip.

While I cannot guarantee that it will fix the issue, a local cargo doc seems to skip the torch-sys build with these added metadata (even if the name is related to docs.rs). So high chance we will be good 🙂

Checklist

  • Confirmed that run-checks all script has been executed.
  • Made sure the book is up to date with changes in this PR.

Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c9cc132) 86.01% compared to head (c64f960) 86.01%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1168      +/-   ##
==========================================
- Coverage   86.01%   86.01%   -0.01%     
==========================================
  Files         522      522              
  Lines       58674    58674              
==========================================
- Hits        50469    50466       -3     
- Misses       8205     8208       +3     

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

Copy link
Member

@nathanielsimard nathanielsimard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember that it was needed when including this backend in the doc. So I think this will work.

@nathanielsimard nathanielsimard merged commit 707b610 into main Jan 23, 2024
15 checks passed
@nathanielsimard nathanielsimard deleted the fix/burn-tch-doc-build branch January 23, 2024 19:14
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.

Build error message in doc.rs burn page
2 participants