Clean up and render changelog #95

Closed nabobalis closed 11 months ago

In GitLab by @dstansby1 on Jun 7, 2021, 02:21

The changelog page in the documentation (https://aiapy.readthedocs.io/en/latest/whatsnew/changelog.html) is an empty page. https://aiapy.readthedocs.io/en/latest/whatsnew/index.html also doesn't have any content.

In GitLab by @wtbarnes on Jun 7, 2021, 05:46

The stable docs do have the rendered changelog for that minor version: https://aiapy.readthedocs.io/en/stable/whatsnew/changelog.html. Should we be rendering a full changelog at each commit to master?

I've not yet bothered with the "What's New" page at all. I suppose that should get deleted if it is not going to be updated.

In GitLab by @wtbarnes on Jun 7, 2021, 05:48

Ah looking at master on sunpy, I see that we include the full changelog for every release on master. I need to clean up old changelog stubs on master anyway so I will render the full thing when I delete those.

In GitLab by @wtbarnes on Jun 7, 2021, 05:51

[ ] Render changelog
[ ] Clean up stubs (since 0.5)
[ ] Remove whatsnew (if we aren't going to use it)

In GitLab by @dstansby1 on Jun 7, 2021, 07:40

Ah, my bad for not looking at the stable branch, thanks for pointing me in that direction. Personally that's what I was after, so happy for this issue to be closed.

In GitLab by @wtbarnes on Jun 8, 2021, 06:45

I'll keep this open to remind me to address the task list above

In GitLab by @wtbarnes on Jun 8, 2021, 10:57

Just some notes so I remember what to do:

Fix url in pyproject.toml
Rerender changelog on master
Clean up all old stubs (i.e. anything that is already on a release branch)

LM-SAL / aiapy

Clean up and render changelog #95