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

Pin sphinx version (fix for current docs build errors) #1382

Merged
merged 4 commits into from
Apr 6, 2020
Merged

Pin sphinx version (fix for current docs build errors) #1382

merged 4 commits into from
Apr 6, 2020

Conversation

awaelchli
Copy link
Member

@awaelchli awaelchli commented Apr 5, 2020

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 to update the docs?
  • Did you write any new necessary tests?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

What does this PR do?

Fixes docs build error currently seen on master and in #1379, #1377
Was also suggested by @jeremyjordan

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 🙃

@mergify mergify bot requested a review from a team April 5, 2020 18:07
@awaelchli awaelchli changed the title Fix docs build error Pin sphinx version Apr 5, 2020
@awaelchli awaelchli changed the title Pin sphinx version Pin sphinx version (fix for current docs build errors) Apr 5, 2020
docs/requirements.txt Outdated Show resolved Hide resolved
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

LGTM

Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com>
@Borda Borda added docs Documentation related priority: 0 High priority task ready PRs ready to be merged ci Continuous Integration labels Apr 5, 2020
@Borda Borda added this to the 0.7.2 milestone Apr 5, 2020
@mergify mergify bot requested a review from a team April 5, 2020 18:12
@codecov
Copy link

codecov bot commented Apr 5, 2020

Codecov Report

Merging #1382 into master will not change coverage by %.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #1382   +/-   ##
======================================
  Coverage      92%     92%           
======================================
  Files          63      63           
  Lines        3323    3323           
======================================
  Hits         3051    3051           
  Misses        272     272           

@awaelchli
Copy link
Member Author

@Borda looks like github action is running sphinx 2.2, so 2.4 is too high?

docs/source/conf.py Outdated Show resolved Hide resolved
Co-Authored-By: Adrian Wälchli <aedu.waelchli@gmail.com>
@Borda Borda requested a review from a team April 5, 2020 22:12
@mergify mergify bot merged commit 5f6be4d into Lightning-AI:master Apr 6, 2020
@mergify
Copy link
Contributor

mergify bot commented Apr 6, 2020

Great job! =)

@awaelchli awaelchli deleted the patch-1 branch April 6, 2020 06:43
bmartinn pushed a commit to bmartinn/pytorch-lightning that referenced this pull request Apr 6, 2020
…1382)

* Update requirements.txt

* Update docs/requirements.txt

Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com>

* freeze sphinx version

* Update docs/source/conf.py

Co-Authored-By: Adrian Wälchli <aedu.waelchli@gmail.com>

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: J. Borovec <jirka.borovec@seznam.cz>
tullie pushed a commit to tullie/pytorch-lightning that referenced this pull request Jun 7, 2020
…1382)

* Update requirements.txt

* Update docs/requirements.txt

Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com>

* freeze sphinx version

* Update docs/source/conf.py

Co-Authored-By: Adrian Wälchli <aedu.waelchli@gmail.com>

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: J. Borovec <jirka.borovec@seznam.cz>
@Borda Borda modified the milestones: v0.7., v0.7.x Apr 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration docs Documentation related priority: 0 High priority task ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants