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.

Sign up for GitHub

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

Jump to bottom

Include changelog in documentation #177

Merged
merged 1 commit into from
Apr 11, 2019
Merged

Include changelog in documentation #177

merged 1 commit into from
Apr 11, 2019

Conversation

theacodes
Copy link
Collaborator

Closes #169

@theacodes theacodes merged commit 861e3cc into master Apr 11, 2019
@theacodes theacodes deleted the include-changelog-in-docs branch April 11, 2019 18:59
@dhermes
Copy link
Collaborator

dhermes commented Apr 11, 2019

@theacodes I've put a lot of effort into making this "work right" for bezier: https://bezier.readthedocs.io/en/latest/releases/index.html

I'm happy to give nox the same treatment. WDYT? (It helps that I can maintain latest.rst in between releases and then just use the RST when creating the GitHub release.)

@theacodes
Copy link
Collaborator Author

I'm not opposed, but can you give me an idea of what we'd change?

@dhermes
Copy link
Collaborator

dhermes commented Apr 11, 2019

  • Give each release it's own page
  • Make sure the GH links render correctly in RTD as well as in GH
  • Add a landing page for the changelog
  • Add a latest doc that you can modify in between releases (this is "copying" what towncrier does but is lighter weight)

@theacodes
Copy link
Collaborator Author

Totally up to you. I'm fine either way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Include changelog in docs
2 participants
@theacodes @dhermes