changelog (HinodeXRT#128)

joyvelasquez · jslavin · namurphy · web-flow · commit e8ca8479353e · 2023-03-16T14:10:02.000-04:00
* Adding sphinx_changelog as an extension'

* Creating a site page: changelog guide

* Test/learning methods of setting up changelog guide

* Added description of xrt_teem

Included brief description of xrt_teem as a new function that was added to XRTpy

* New file for changelog

* Add sphinx extensions

* Add changelog to toc-tree

* Added towncrier

* New location for changelog files

* Adding sphinx-issues

* Adding sphinx-issues

* Removed block code text

* Add PR104: Fix time handling in contamination calculations.

* Adding changelog for xrt_teem

* Updated effective area example notebook.

* Addressing temperature response NAN

* Updated temperature response example notebook.

* Changes seciton to removal

* Updated to bugfit

* Updated to new feature

* Delete 89.doc.rst

* Update changelog/104.removal.rst

Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;

* Update changelog/89.feature.rst

Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;

* Update docs/changelog_guide.rst

Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;

* Delete 104.doc.rst

* Delete 111.doc.rst

* Update docs/index.rst

Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;

* Delete index.rst

* Delete 89. feature.rst

* Delete changelog_guide.rst

* Update changelog/111.bugfix.rst

Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;

* Update changelog/89.feature.rst

Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;

* Update pyproject.toml

Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;

* Add index page for changelog

* Update index.rst

---------

Co-authored-by: Jonathan Slavin &lt;jslavin37@gmail.com&gt;
Co-authored-by: Nick Murphy &lt;namurphy@cfa.harvard.edu&gt;
diff --git a/changelog/102.doc.rst b/changelog/102.doc.rst
@@ -0,0 +1 @@
+Updated effective area example notebook.
diff --git a/changelog/104.removal.rst b/changelog/104.removal.rst
@@ -0,0 +1 @@
+Fixed time handling in contamination calculations using `astropy.time`.
diff --git a/changelog/111.bugfix.rst b/changelog/111.bugfix.rst
@@ -0,0 +1 @@
+Addressed and fixed the temperature response 'NAN' calculations output.
diff --git a/changelog/128.doc.rst b/changelog/128.doc.rst
@@ -0,0 +1 @@
+Added a changelog.
diff --git a/changelog/89.feature.rst b/changelog/89.feature.rst
@@ -0,0 +1 @@
+Derived temperature and emission measure for a pair of images, `xrtpy.response.xrt_teem.xrt_teem`.
diff --git a/changelog/94.doc.rst b/changelog/94.doc.rst
@@ -0,0 +1 @@
+Updated temperature response example notebook.
diff --git a/docs/changelog/dev.rst b/docs/changelog/dev.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+==================
+Unreleased changes
+==================
+
+.. changelog::
+   :towncrier: ../../
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -0,0 +1,14 @@
+.. _changelog:
+
+#########
+Changelog
+#########
+
+This document lists the changes made during each release of XRTpy,
+including bug fixes and changes to the application programming interface
+(API).
+
+.. toctree::
+   :maxdepth: 1
+
+   dev
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,10 +35,12 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
     "nbsphinx",
+    "sphinx_changelog",
     "sphinx_copybutton",
     "sphinx_gallery.load_style",
     "IPython.sphinxext.ipython_console_highlighting",
     "sphinx_changelog",
+    "sphinx_issues",
     "sphinxcontrib.bibtex",
     "hoverxref.extension",
 ]
diff --git a/docs/index.rst b/docs/index.rst
@@ -25,6 +25,7 @@ for the analysis of observations made by the `X-Ray Telescope`_ (XRT)
    examples
    bibliography
    glossary
+   changelog/index
    feedback_communication
    contributing/index
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,3 +31,42 @@ te
 
 [tool.gilesbot.pull_requests]
 enabled = true
+
+[tool.towncrier]
+package = "xrtpy"
+name = "XRTpy"
+filename = "CHANGELOG.rst"
+directory = "changelog/"
+title_format = "{name} v{version} ({project_date})"
+issue_format = ":pr:`{issue}`"  # Despite the name mismatch, we use this for linking to PRs
+wrap = true
+
+[[tool.towncrier.type]]
+directory = "breaking"
+name = "Backwards Incompatible Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removal"
+name = "Deprecations and Removals"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bug Fixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "doc"
+name = "Improved Documentation"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "trivial"
+name = "Trivial/Internal Changes"
+showcontent = true
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -17,6 +17,7 @@ sphinx-changelog
 sphinx-copybutton
 sphinx-gallery < 0.11.0
 sphinx-hoverxref
+sphinx-issues
 sphinx_automodapi
 sphinx_rtd_theme >= 1.0.0
 sphinxcontrib-bibtex
diff --git a/setup.cfg b/setup.cfg
@@ -74,6 +74,7 @@ docs =
     sphinx-copybutton
     sphinx-gallery < 0.11.0
     sphinx-hoverxref
+    sphinx-issues
     sphinx_rtd_theme >= 1.0.0
     sphinxcontrib-bibtex
     towncrier >= 20.0

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Updated effective area example notebook.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Fixed time handling in contamination calculations using `astropy.time`.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Addressed and fixed the temperature response 'NAN' calculations output.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Derived temperature and emission measure for a pair of images, `xrtpy.response.xrt_teem.xrt_teem`.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Updated temperature response example notebook.`