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: initialize Sphinx Gallery #2508

Merged
merged 28 commits into from
May 6, 2024
Merged

docs: initialize Sphinx Gallery #2508

merged 28 commits into from
May 6, 2024

Conversation

Borda
Copy link
Member

@Borda Borda commented Apr 18, 2024

What does this PR do?

Init for #2438
references:

Remaining todo:

  • make thumbnail larger -> another PR
  • skip gallery for fast docs builds
  • add extra job/check for gallery
Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃


📚 Documentation preview 📚: https://torchmetrics--2508.org.readthedocs.build/en/2508/

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 18, 2024
@Borda
Copy link
Member Author

Borda commented Apr 18, 2024

asking about supporting ! pip install ... in sphinx-gallery/sphinx-gallery#129

@Borda
Copy link
Member Author

Borda commented Apr 19, 2024

@Borda Borda added this to the future milestone Apr 24, 2024
@Borda Borda marked this pull request as ready for review April 29, 2024 13:31
@Borda Borda requested a review from stancld as a code owner April 29, 2024 13:31
Copy link

codecov bot commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69%. Comparing base (f6d1f44) to head (6a57e5a).

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #2508   +/-   ##
======================================
  Coverage      69%     69%           
======================================
  Files         313     313           
  Lines       17617   17617           
======================================
  Hits        12163   12163           
  Misses       5454    5454           

@stancld
Copy link
Contributor

stancld commented May 4, 2024

Looks cool ❤️

requirements/_docs.txt Outdated Show resolved Hide resolved
@mergify mergify bot added the ready label May 4, 2024
@Borda Borda merged commit c62a58c into master May 6, 2024
70 checks passed
@Borda Borda deleted the docs/gallery branch May 6, 2024 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants