-
Notifications
You must be signed in to change notification settings - Fork 323
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
Remove transitions from docs to comply with warnings from sphinx-check
#491
Remove transitions from docs to comply with warnings from sphinx-check
#491
Conversation
Codecov Report
@@ Coverage Diff @@
## master #491 +/- ##
=======================================
Coverage 79.10% 79.10%
=======================================
Files 102 102
Lines 5892 5892
=======================================
Hits 4661 4661
Misses 1231 1231
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
69afb74
to
a72766c
Compare
d9e27b6
to
e11b5c9
Compare
@Borda It seems there is no way to disable |
yeah, I was thinking rather fix the warnings then suppress them from PRs :] |
@@ -39,16 +39,12 @@ DQN Loss | |||
.. autofunction:: pl_bolts.losses.rl.dqn_loss | |||
:noindex: | |||
|
|||
--------------- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that @williamFalcon made it on purpose, so is there another way how to have a horizontal line?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I looked through the docs, but I'm still not sure if there's another way to draw a horizontal line...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could it be this one? https://docutils.sourceforge.io/docs/ref/doctree.html#transition
so let's just remove it at this moment :]
mind check the two failing test for make and test docs seem like we need to mock the packages... |
…g-bolts into ci/fix-sphinx-check
sphinx-check
[wip]sphinx-check
sphinx-check
sphinx-check
@Borda Would you mind checking the changes again? |
What does this PR do?
Fixes #490.
This PR removes transitions in the docs to resolve warnings:
from CI
sphinx-check
.Below is the example of the changes in the docs. https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#byol
Before the change
After the change
Before submitting
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 🙃