Skip to content

Update documentation to support new 'autochangelog' setup.#103

Merged
mergify[bot] merged 1 commit intorelease-depot:masterfrom
jguiditta:doc_updates
Oct 14, 2021
Merged

Update documentation to support new 'autochangelog' setup.#103
mergify[bot] merged 1 commit intorelease-depot:masterfrom
jguiditta:doc_updates

Conversation

@jguiditta
Copy link
Copy Markdown
Member

  • Removed unused HISTORY.rst
  • Updated stale AUTHORS.rst

Signed-off-by: Jason Guiditta jguiditt@redhat.com

fuzzball81
fuzzball81 previously approved these changes Oct 14, 2021
Copy link
Copy Markdown
Contributor

@jpichon jpichon left a comment

Choose a reason for hiding this comment

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

Sorry about the integration tests shenanigans. I think we also need to remove HISTORY.rst from setup.cfg (and replace it with the changelog if that's possible, not sure because of the mix of rst and md. Maybe just a link in the README to the RTD changelog instead?). I'm surprised the twine check doesn't catch this, since it was meant to help up catch README/HISTORY formatting issues before uploading to pypi.

@jguiditta
Copy link
Copy Markdown
Member Author

Good catch, I thought I had removed the history file from there already. I'll look if there is a separate key we can use in setup.cfg for history/changelog, as the current setup will certainly not work. If not, I'll add a link as you suggest.

@jguiditta jguiditta force-pushed the doc_updates branch 2 times, most recently from 2bd48d3 to e68b309 Compare October 14, 2021 13:39
* Removed unused HISTORY.rst
* Updated stale AUTHORS.rst
* Moved README from rst to md so we can include both in our
  long_description in setup.cfg

Signed-off-by: Jason Guiditta <jguiditt@redhat.com>
@jguiditta jguiditta requested a review from fuzzball81 October 14, 2021 14:02
@mergify mergify Bot merged commit fdf1e31 into release-depot:master Oct 14, 2021
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.

3 participants