docs: move changelog to docs/en and allow sphinx directives#6287
Merged
nicoddemus merged 1 commit intopytest-dev:masterfrom Nov 29, 2019
Merged
docs: move changelog to docs/en and allow sphinx directives#6287nicoddemus merged 1 commit intopytest-dev:masterfrom
nicoddemus merged 1 commit intopytest-dev:masterfrom
Conversation
blueyed
reviewed
Nov 28, 2019
Contributor
blueyed
left a comment
There was a problem hiding this comment.
Now
tox -e docswill also include the draft changelog for the
next version (locally only).
Isn't it included always now? (since the Sphinx tag is used always - but maybe the idea is that RTD does not use the tag?)
I've used docs-draft to have an explicit distinction there, i.e. docs would be what you get for an release (without towncrier being run).
I'm not opposed to have it simplified into a single env though really, just wanted to confirm.
Now `tox -e docs` will also include the draft changelog for the next version (locally only). `CHANGELOG.rst` now only points to the changelog on READTHEDOCS so sphinx diretives can be used. Followup to pytest-dev#6272
a1240ad to
d3ab56f
Compare
Member
Author
Exactly! I've added comments to make that more clear. 👍 |
RonnyPfannschmidt
approved these changes
Nov 29, 2019
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Now
tox -e docswill also include the draft changelog for thenext version (locally only).
CHANGELOG.rstnow only points to the changelog on READTHEDOCS sosphinx diretives can be used.
Followup to #6272