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

Begin improvement of refs generation #59

Merged
merged 10 commits into from
Oct 7, 2024
Merged

Conversation

lebrice
Copy link
Collaborator

@lebrice lebrice commented Oct 3, 2024

Idea:

  • Tweak the AutoRefsPlugin so that text in backticks like this (more IDE-friendly) are converted to refs in the docs when possible.
  • Also fix refs like [lightning.Trainer][] so that they become [lightning.Trainer][lightning.pytorch.trainer.trainer.Trainer] or whatever is necessary for it to be properly displayed.

Signed-off-by: Fabrice Normandin normandf@mila.quebec

@codecov-commenter
Copy link

codecov-commenter commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.79%. Comparing base (803d5c8) to head (245da3e).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #59      +/-   ##
==========================================
+ Coverage   70.99%   71.79%   +0.80%     
==========================================
  Files          59       61       +2     
  Lines        3554     3620      +66     
==========================================
+ Hits         2523     2599      +76     
+ Misses       1031     1021      -10     

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

@lebrice lebrice marked this pull request as ready for review October 7, 2024 13:28
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
Trying the same approach as DSD-DBS/capella-dockerimages@6e38a0c

Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
There's this issue at the moment with some reproducibility test
that cause the CI to fail.

I'll make another PR to address this, but for now, I'm turning off
the 'shared regression files in $SCRATCH' feature.

Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
@lebrice lebrice merged commit 2a233f6 into master Oct 7, 2024
7 checks passed
@lebrice lebrice deleted the lebrice/fix-autoref-plugin branch October 7, 2024 16:11
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.

4 participants