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

Remove transitions from docs to comply with warnings from sphinx-check #491

Merged
merged 6 commits into from
Jan 3, 2021

Conversation

akihironitta
Copy link
Contributor

@akihironitta akihironitta commented Jan 3, 2021

What does this PR do?

Fixes #490.

This PR removes transitions in the docs to resolve warnings:

Document or section may not begin with a transition.

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

tmp

After the change

tmp

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests? [not needed for typos/docs]
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

  • Is this pull request ready for review? (if not, please submit in draft mode)

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 🙃

@codecov
Copy link

codecov bot commented Jan 3, 2021

Codecov Report

Merging #491 (cf95a86) into master (edc6553) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #491   +/-   ##
=======================================
  Coverage   79.10%   79.10%           
=======================================
  Files         102      102           
  Lines        5892     5892           
=======================================
  Hits         4661     4661           
  Misses       1231     1231           
Flag Coverage Δ
cpu 25.19% <ø> (ø)
pytest 25.19% <ø> (ø)
unittests 78.54% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update edc6553...cf95a86. Read the comment docs.

@akihironitta akihironitta reopened this Jan 3, 2021
@akihironitta
Copy link
Contributor Author

akihironitta commented Jan 3, 2021

@Borda It seems there is no way to disable Unchanged files with check annotations (Beta) as the issue actions/toolkit#457 is still open, so I'll try to resolve those warnings from sphinx-check in this PR instead of turning off the feature Unchanged files with check annotations (Beta).

@Borda
Copy link
Member

Borda commented Jan 3, 2021

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:

---------------
Copy link
Member

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?

Copy link
Contributor Author

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...

Copy link
Member

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 :]

@Borda Borda added fix fixing issues... documentation Improvements or additions to documentation labels Jan 3, 2021
@Borda
Copy link
Member

Borda commented Jan 3, 2021

mind check the two failing test for make and test docs seem like we need to mock the packages...

@akihironitta akihironitta marked this pull request as ready for review January 3, 2021 16:57
@akihironitta akihironitta changed the title Fix "Document or section may not begin with a transition" from sphinx-check [wip] Fix "Document or section may not begin with a transition" from sphinx-check Jan 3, 2021
@akihironitta akihironitta changed the title Fix "Document or section may not begin with a transition" from sphinx-check Remove transitions from docs to comply with warnings from sphinx-check Jan 3, 2021
@akihironitta
Copy link
Contributor Author

@Borda Would you mind checking the changes again?

@Borda Borda merged commit a189d7c into Lightning-Universe:master Jan 3, 2021
@akihironitta akihironitta deleted the ci/fix-sphinx-check branch January 3, 2021 20:29
@Borda Borda added this to the v0.3 milestone Jan 18, 2021
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 fix fixing issues...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"Document or section may not begin with a transition" warnings from sphinx-check
2 participants