appendix: Rename "Version History" to "Changelog"

As requested here: #422 (comment)
mixxxdj · Sep 1, 2021 · 39cee02 · 39cee02
1 parent a10f31a
commit 39cee02
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 13 deletions.
diff --git a/source/chapters/appendix.rst b/source/chapters/appendix.rst
@@ -11,4 +11,4 @@ Appendix
    appendix/commandline_dev_tools
    appendix/mixxx_controls
    appendix/additional_resources
-   appendix/version_history
+   appendix/changelog
diff --git a/source/chapters/appendix/version_history.rst → source/chapters/appendix/changelog.rst b/source/chapters/appendix/version_history.rst → source/chapters/appendix/changelog.rst
diff --git a/tools/update_changelog.py b/tools/update_changelog.py
@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 import argparse
 import os
-import re
 
 import m2r2
 import requests
@@ -13,7 +12,7 @@
 
 .. include:: /shortcuts.rstext
 
-.. _appendix-version-history:
+.. _appendix-changelog:
 
 {content}
 
@@ -34,14 +33,6 @@ def fetch_changelog(branch):
 
 def changelog_to_rst(changelog):
     """ Convert changelog to RST format used by sphinx. """
-    # Replace headline with "Version History"
-    changelog = re.sub(
-        "^# Changelog$",
-        "# Version History",
-        changelog,
-        flags=re.MULTILINE | re.IGNORECASE,
-    )
-
     return TEMPLATE.lstrip().format(content=m2r2.convert(changelog))
 
 
@@ -54,10 +45,10 @@ def main(argv=None):
     changelog = fetch_changelog(args.branch)
     changelog = changelog_to_rst(changelog)
 
-    # Write changelog to version_history.rst file
+    # Write changelog to changelog.rst file
     path = os.path.join(
         os.path.dirname(os.path.abspath(__file__)),
-        "../source/chapters/appendix/version_history.rst",
+        "../source/chapters/appendix/changelog.rst",
     )
     with open(path, mode="w") as fp:
         fp.write(changelog)