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: try autobuild for local dev #2518

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

docs: try autobuild for local dev #2518

wants to merge 5 commits into from

Conversation

Borda
Copy link
Member

@Borda Borda commented Apr 27, 2024

What does this PR do?

This could be an exciting feature for faster interaction during local development, ref: https://github.com/sphinx-doc/sphinx-autobuild

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--2518.org.readthedocs.build/en/2518/

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 27, 2024
@Borda Borda marked this pull request as ready for review May 6, 2024 22:29
@Borda Borda requested a review from a team May 6, 2024 22:29
Copy link

codecov bot commented May 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69%. Comparing base (c1f74b0) to head (ba4ccc2).
Report is 3 commits behind head on master.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #2518   +/-   ##
======================================
  Coverage      69%     69%           
======================================
  Files         313     313           
  Lines       17617   17617           
======================================
  Hits        12162   12162           
  Misses       5455    5455           

@Borda
Copy link
Member Author

Borda commented May 11, 2024

@baskrahmer, have you tried this one, and do you see the difference? :)

@Borda Borda mentioned this pull request May 13, 2024
4 tasks
@mergify mergify bot removed the has conflicts label May 14, 2024
@Borda
Copy link
Member Author

Borda commented May 15, 2024

hit this issue sphinx-doc/sphinx-autobuild#155 (comment)
let's wait until sphinx-doc/sphinx-autobuild#157 is released

@Borda
Copy link
Member Author

Borda commented May 15, 2024

another complication described in sphinx-doc/sphinx-autobuild#162

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant