Skip to content

Conversation

@akihironitta
Copy link
Contributor

What does this PR do?

Fixes #7455.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • 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? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@akihironitta akihironitta added bug Something isn't working docs Documentation related ci Continuous Integration labels May 9, 2021
@akihironitta akihironitta requested a review from Borda May 9, 2021 15:18
@codecov
Copy link

codecov bot commented May 9, 2021

Codecov Report

Merging #7456 (20dd399) into master (1af42d7) will decrease coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #7456   +/-   ##
======================================
- Coverage      92%     92%   -0%     
======================================
  Files         199     199           
  Lines       13030   13030           
======================================
- Hits        11989   11951   -38     
- Misses       1041    1079   +38     

@akihironitta akihironitta changed the title Pin Sphinx<4.0.0 Pin Sphinx<4.0.0 [wip] May 9, 2021
@akihironitta akihironitta changed the title Pin Sphinx<4.0.0 [wip] Pin Sphinx<4.0.0 May 9, 2021
@akihironitta akihironitta changed the title Pin Sphinx<4.0.0 Pin Sphinx<4.0 May 9, 2021
akihironitta and others added 2 commits May 10, 2021 01:11
There is no other release between 3.5 and 4.0
@@ -1,4 +1,4 @@
sphinx>=3.0, !=3.5 # fails with sphinx.ext.viewcode
sphinx>=3.0, !=3.5, <4.0 # fails with sphinx.ext.viewcode # fails with sphinx_paramlinks with 4.0.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was no other release between 3.5 and 4.0

Copy link
Contributor Author

@akihironitta akihironitta May 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was wondering why it was using 3.5.4 in the very last successful runs even though we specified !=3.5:

Sphinx                        3.5.4

https://github.com/PyTorchLightning/pytorch-lightning/runs/2535513652

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

@tchaton tchaton added the ready PRs ready to be merged label May 10, 2021
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to wait for a sphinx-paramlinks update like last time :)

@awaelchli awaelchli added this to the v1.4 milestone May 10, 2021
@Borda Borda merged commit 6d82dc8 into master May 10, 2021
@Borda Borda deleted the ci/pin-sphinx branch May 10, 2021 08:27
@carmocca carmocca mentioned this pull request May 10, 2021
Borda added a commit that referenced this pull request May 11, 2021
* Dont use sphinx 4.0.0

* Dont use sphinx 4.0.0

* Update comment

* Simple

There is no other release between 3.5 and 4.0

Co-authored-by: Jirka Borovec <[email protected]>
(cherry picked from commit 6d82dc8)
Borda added a commit that referenced this pull request May 11, 2021
* Dont use sphinx 4.0.0

* Dont use sphinx 4.0.0

* Update comment

* Simple

There is no other release between 3.5 and 4.0

Co-authored-by: Jirka Borovec <[email protected]>
(cherry picked from commit 6d82dc8)
Borda added a commit that referenced this pull request May 11, 2021
* Dont use sphinx 4.0.0

* Dont use sphinx 4.0.0

* Update comment

* Simple

There is no other release between 3.5 and 4.0

Co-authored-by: Jirka Borovec <[email protected]>
(cherry picked from commit 6d82dc8)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working ci Continuous Integration docs Documentation related ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs build error in Sphinx 4.0.0

4 participants