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

Include changelog in docs #169

Closed
stsewd opened this issue Feb 19, 2019 · 4 comments · Fixed by #177
Closed

Include changelog in docs #169

stsewd opened this issue Feb 19, 2019 · 4 comments · Fixed by #177

Comments

@stsewd
Copy link
Collaborator

stsewd commented Feb 19, 2019

How would this feature be useful?

Right now the changelog lives only in the repo.
Would be nice to have it in http://nox.thea.codes/en/stable/changelog.html where it's more visible.

We could just link from there to the file in the repo or convert the file from markdown to rst, so it would be rendered in the docs page.

@theacodes
Copy link
Collaborator

This is a great idea. I'm all for it.

@stsewd
Copy link
Collaborator Author

stsewd commented Feb 19, 2019

Are you 👍 on changing from markdown to rst?

@dhermes
Copy link
Collaborator

dhermes commented Feb 19, 2019

May be useful to use https://pypi.org/project/towncrier/

Also the Changelog approach from bezier may be worth a look: https://github.com/dhermes/bezier/tree/master/docs/releases

@theacodes
Copy link
Collaborator

theacodes commented Feb 19, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

3 participants