Fix rendered towncrier changelog to be consistent with the way towncr…

…ier does it (#12) * Fix rendered towncrier changelog to be consistent with the way towncrier does it * Fix template to not include top_line * Fix code style * Added news fragment * Add a conditional check to hack around the default template Co-authored-by: Stuart Mumford <stuart@cadair.com>
OpenAstronomy · Aug 19, 2021 · 39909a2 · 39909a2
1 parent a5905cc
commit 39909a2
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/changelog/12.bugfix.rst b/changelog/12.bugfix.rst
@@ -0,0 +1 @@
+Fixed rendering to match towncrier, which means that top_line should not be included in the template.
diff --git a/changelog/template.rst b/changelog/template.rst
@@ -1,5 +1,5 @@
 {% if top_line %}
-{{ top_line }}
+
 {{ top_underline * ((top_line)|length)}}
 {% elif versiondata.name %}
 {{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})

diff --git a/sphinx_changelog/towncrier.py b/sphinx_changelog/towncrier.py
@@ -112,4 +112,11 @@ def generate_changelog_for_docs(directory, skip_if_empty=True, underline=1):
     )
 
     os.chdir(curdir)
+
+    # To work around https://github.com/twisted/towncrier/issues/346 we check
+    # to see if the template is going to write the top_line, and if it isn't
+    # then we write it.
+    if "{{ top_line }}" not in template:
+        rendered = top_line + rendered
+
     return rendered
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fixed rendering to match towncrier, which means that top_line should not be included in the template.