Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog to documentation #550

Merged
merged 4 commits into from
Mar 23, 2023
Merged

Add changelog to documentation #550

merged 4 commits into from
Mar 23, 2023

Conversation

mdickinson
Copy link
Member

@mdickinson mdickinson commented Mar 22, 2023

This PR adds the changelog to the Sphinx documentation, under the heading "Release history".

I also had to make a fix to the Sphinx configuration file in order to make the docs build at all, which suggest that we should have a CI build for the documentation. I'll make a separate issue for that.

Partial screenshot below. It's not pretty, but it's functional.

Closes #516

Screenshot 2023-03-22 at 15 43 12

@mdickinson
Copy link
Member Author

mdickinson commented Mar 22, 2023

I'll make a separate issue for that.

See #552 (with fix in #551).

Copy link
Contributor

@corranwebster corranwebster left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM; one comment

docs/source/index.rst Outdated Show resolved Hide resolved
@mdickinson
Copy link
Member Author

Merged main in so that we can get the benefit of the doc build test workflow.

@mdickinson
Copy link
Member Author

Doc build succeeds, and resulting docs are as expected.

@mdickinson mdickinson merged commit 760746e into main Mar 23, 2023
@mdickinson mdickinson deleted the add-changelog-to-docs branch March 23, 2023 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include changelog in generated documentation
2 participants