Add configuration for sphinx rendering of the changelog

[ci skip]
JasonS09 · Apr 2, 2021 · 7536262 · 7536262
1 parent 91ace14
commit 7536262
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 9 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -4,4 +4,6 @@
 Full Changelog
 **************
 
-.. include:: ../CHANGES.rst
+.. changelog::
+   :towncrier: ../
+   :changelog_file: ../CHANGES.rst
diff --git a/docs/changes/template.rst b/docs/changes/template.rst
@@ -1,11 +1,3 @@
-{% if versiondata.name %}
-{{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
-{{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
-{% else %}
-{{ versiondata.version }} ({{ versiondata.date }})
-{{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
-{% endif %}
-
 {% for category, val in definitions.items() %}
 {% set underline = underlines[0] %}
 {{ definitions[category]['name'] }}

diff --git a/docs/conf.py b/docs/conf.py
@@ -78,6 +78,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns.append('_templates')  # noqa: F405
+exclude_patterns.append('changes')  # noqa: F405
 exclude_patterns.append('_pkgtemplate.rst')  # noqa: F405
 exclude_patterns.append('**/*.inc.rst')  # .inc.rst mean *include* files, don't have sphinx process them  # noqa: F405, E501
 
@@ -86,6 +87,9 @@
     templates_path = []
 templates_path.append('_templates')
 
+
+extensions += ["sphinx_changelog"]  # noqa: F405
+
 # Grab minversion from setup.cfg
 setup_cfg = configparser.ConfigParser()
 setup_cfg.read(os.path.join(os.path.pardir, 'setup.cfg'))

diff --git a/setup.cfg b/setup.cfg
@@ -85,6 +85,7 @@ docs =
     PyYAML>=3.13
     scipy>=1.1
     matplotlib>=3.1,!=3.4.0
+    sphinx-changelog
 
 [options.package_data]
 * = data/*, data/*/*, data/*/*/*, data/*/*/*/*, data/*/*/*/*/*, data/*/*/*/*/*/*