-
Notifications
You must be signed in to change notification settings - Fork 310
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
Fix changelog formatting #299
Labels
Comments
(We could also switch to using Sphinx's built-in |
I'm not sure the |
OK. I'll fix up this branch to work with |
brainwane
added a commit
to brainwane/twine
that referenced
this issue
Feb 28, 2018
Fix formatting so the releases Sphinx plugin can parse each item, per pypa#299.
brainwane
added a commit
to brainwane/twine
that referenced
this issue
Feb 28, 2018
Add semantically relevant markup to past items to ensure each release section includes its bugs, features, and other relevant line items. Per pypa#299.
Merged
Fixed in #305. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Twine's changelog, as represented on Read The Docs and when I build the docs locally, only displays version number 1.4.0 (2014-12-12) and two associated GitHub issues. This is inaccurate since
changelog.rst
has 70+ items and runs up to version 1.9.1 (2017-05-27).This is happening because
changelog.rst
is meant to be formatted so the Sphinx extensionreleases
can parse it, andreleases
misparses what's in there right now.I'm working on this in my
changelog-fix
branch and, mostly by fixing indentation and newlines, I've gotten a lot more information to display, but several items that have already shipped in releases are at the top of the page and marked as waiting for future releases. I think this is because we basically always ship bugfixes in whatreleases
thinks of as feature releases, operating similarly to "unstable prehistory" mode, and so I need to be inelegant and explicitly mark these items explicitly as each applying to/included in the next release.Work in progress.
The text was updated successfully, but these errors were encountered: