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

Fix our documentation build and changelog rendering #10607

Merged
merged 2 commits into from
Oct 22, 2021

Conversation

pradyunsg
Copy link
Member

@pradyunsg pradyunsg commented Oct 22, 2021

This should allow newer versions of Sphinx, which contain bugfixes for
Python 3.10 support.

Also fixes towncrier template for multiple bullets.

@pradyunsg pradyunsg added the type: docs Documentation related label Oct 22, 2021
@pradyunsg pradyunsg changed the title Bup to Sphinx 4.2 and above Bump to Sphinx 4.2 and above Oct 22, 2021
This should allow newer versions of Sphinx, which contain bugfixes for
Python 3.10 support.
@uranusjr
Copy link
Member

Oh no race condition

@pradyunsg pradyunsg added the skip news Does not need a NEWS file entry (eg: trivial changes) label Oct 22, 2021
@pradyunsg
Copy link
Member Author

Relevant here: sphinx-doc/sphinx#9646

@uranusjr
Copy link
Member

Hmm, towncrier rendering seems broken

https://pip--10607.org.readthedocs.build/en/10607/news/

towncrier renders with `trim_blocks=True` which trims the newline at the
start of the for loop's body. This adds an additional newline which is
not trimmed, which ensures that the code blocks don't blend into each
other.
@pradyunsg
Copy link
Member Author

Hmm, towncrier rendering seems broken

Indeed! Nice catch! ^>^

Fixed! I never tested with multiple bullets in the same section. I guess, good thing we have had so many PRs. XD

@pradyunsg pradyunsg changed the title Bump to Sphinx 4.2 and above Fix our documentation build and changelog rendering Oct 22, 2021
@pradyunsg pradyunsg added this to the 21.3.1 milestone Oct 22, 2021
@pradyunsg pradyunsg merged commit 7b3c122 into pypa:main Oct 22, 2021
@pradyunsg pradyunsg deleted the fix-docs-builds branch October 22, 2021 09:19
pradyunsg added a commit to pradyunsg/pip that referenced this pull request Oct 22, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 7, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants