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 changelog misformat #9817

Merged
merged 7 commits into from Apr 17, 2021
Merged

Fix changelog misformat #9817

merged 7 commits into from Apr 17, 2021

Conversation

uranusjr
Copy link
Member

Fix #9815.

@uranusjr uranusjr marked this pull request as draft April 17, 2021 17:12
@uranusjr uranusjr added the skip news Does not need a NEWS file entry (eg: trivial changes) label Apr 17, 2021
@webknjaz
Copy link
Member

FYI this is how the default template looks now: https://github.com/twisted/towncrier/blob/master/src/towncrier/templates/default.rst

@pradyunsg
Copy link
Member

@uranusjr if you're frustrated, would it help if I pick up this issue? I'm happy to, and it helps that I've been writing a bunch of Jinja templates lately.

@uranusjr
Copy link
Member Author

uranusjr commented Apr 17, 2021

Alright, this is the best I can do. The HTML is now correct, but the rendered NEWS.rst will now have a ton of blank lines between the version title and subsections:

.. towncrier release notes start

21.1.dev0 (2021-04-18)
======================



Process
-------
 
- Start installation scheme migration from ``distutils`` to ``sysconfig``. A

Every attempt I made trying to remove even one of them breaks the HTML.

@uranusjr uranusjr marked this pull request as ready for review April 17, 2021 17:41
@uranusjr uranusjr requested a review from webknjaz April 17, 2021 17:42
@webknjaz
Copy link
Member

RTD preview seems fine now and it's probably the main thing to care about right now. That jinja2 template can be edited later if someone is in the mood to entertain themself...

@uranusjr
Copy link
Member Author

This is better than what we have in main now.

@uranusjr uranusjr merged commit cf2c2cc into pypa:main Apr 17, 2021
@uranusjr uranusjr deleted the fix-doc-misformat branch April 17, 2021 23:44
@webknjaz webknjaz mentioned this pull request May 6, 2021
@webknjaz
Copy link
Member

webknjaz commented May 6, 2021

@uranusjr FYI apparently we still have a problem: #9828 (comment) / pypa/setuptools#2666

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 29, 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)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recent change to Towncrier generation doesn't handle newlines properly
3 participants