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 rendered towncrier changelog to be consistent with the way towncrier does it #12

Merged
merged 5 commits into from
Aug 19, 2021

Conversation

astrofrog
Copy link
Contributor

@astrofrog astrofrog commented Aug 18, 2021

When running towncrier, the top_line is output before the rendered content based on the template - this means that {top_line} should not be included in the template otherwise the title appears twice. See:

for a fix to the template in astropy core to avoid this issue. See also this code in towncrier which shows the top line is output before the rendered content.

This PR then updates sphinx-changelog to also output the top line separately from the rendered content. With this and astropy/astropy#12083, the astropy docs finally build with no errors related to section headings for me.

This is a known issue in towncrier:

@Cadair Cadair merged commit 39909a2 into OpenAstronomy:main Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants