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.

Sign up for GitHub

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

Jump to bottom

Fix docs build on Sphinx 2.0.0 #3480

Merged
merged 6 commits into from
Mar 30, 2019
Merged

Fix docs build on Sphinx 2.0.0 #3480

merged 6 commits into from
Mar 30, 2019

Conversation

luhn
Copy link
Contributor

@luhn luhn commented Mar 30, 2019

Sphinx 2.0.0 was released, which triggered some warnings when building
the docs and caused the build to fail.

luhn added 2 commits March 30, 2019 11:45
@luhn
Fix docs build on Sphinx 2.0.0
7250de6 
Sphinx 2.0.0 was released, which triggered some warnings when building
the docs and caused the build to fail.
@luhn
Sign CONTRIBUTORS.txt
e08c895
@luhn
Copy link
Contributor Author

luhn commented Mar 30, 2019

Hmmm, have some errors in the epub build I can't quite puzzle out.

@luhn
Copy link
Contributor Author

luhn commented Mar 30, 2019

There we are!

@stevepiercy
Copy link
Member

Read The Docs is currently on Sphinx 1.8.5. We might need to pin Sphinx, or account for two versions, if there is a version incompatibility.

stevepiercy
stevepiercy reviewed Mar 30, 2019
View reviewed changes
Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

@luhn can you confirm that the docs will build on both Sphinx 1.8.5 and 2.x? Otherwise LGTM.

@luhn
Copy link
Contributor Author

luhn commented Mar 30, 2019

Yeah, works on both 1.8.5 and 2.0.0. I've pinned it to 1.8.5 so Travis tests against same sphinx as RTD, but this PR will at least future-proof the docs.

Where are you getting that RTD is Sphinx 1.8.5? I can't find a reference for that.

stevepiercy
stevepiercy reviewed Mar 30, 2019
View reviewed changes
setup.py Outdated Show resolved Hide resolved
@stevepiercy stevepiercy self-requested a review March 30, 2019 20:33
@stevepiercy
Copy link
Member

Oops, approved too soon. There should also be a changelog entry under https://github.com/Pylons/pyramid/blame/master/CHANGES.rst#L91

@luhn
Copy link
Contributor Author

luhn commented Mar 30, 2019 •
edited
Loading

Will do.

Should I backport to 1.10-branch as well? 1.9-branch?

@stevepiercy
Copy link
Member

Should I backport to 1.10-branch as well? 1.9-branch?

Yes, please.

@stevepiercy stevepiercy merged commit 01618a1 into Pylons:master Mar 30, 2019
This was referenced Mar 30, 2019
Merged
Merged
stevepiercy added a commit that referenced this pull request Mar 31, 2019
@stevepiercy
Merge pull request #3481 from luhn/sphinx-2.0-1.10
31e99c3 
Backport #3480 to 1.10
stevepiercy added a commit that referenced this pull request Mar 31, 2019
@stevepiercy
Merge pull request #3482 from luhn/sphinx-2.0-1.9
09c0c6f 
Backfill #3480 to 1.9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevepiercy stevepiercy stevepiercy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@luhn @stevepiercy