Skip to content

docs: allow for Sphinx directives in changelogs #6272

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
Closed
wants to merge 9 commits into from
Closed

docs: allow for Sphinx directives in changelogs #6272

wants to merge 9 commits into from

Conversation

blueyed
Copy link
Contributor

@blueyed blueyed commented Nov 25, 2019 •
edited
Loading

Fixes #4283.

TODO:

  • update doc with regard to using towncrier to view drafts, should recommend uisng tox -e docs-draft instead.

2019-11-25-062631_1070x992_escrotum

@blueyed blueyed added type: docs documentation improvement, missing or needing clarification type: enhancement new feature or API change, should be merged into features branch labels Nov 25, 2019
@blueyed
Copy link
Contributor Author

blueyed commented Nov 25, 2019

(I've initially moved CHANGELOG.rst into doc/en/changelog.txt, but this conflicted - I still think it would be better, and CHANGELOG.rst could be a symlink to it then. This would have the benefit of clearly having it in Sphinx's root directory where it belongs, instead of including it there only - helping linting tools to know that this is a Sphinx-based file)

@blueyed blueyed changed the title Docs: allow for Sphinx directives in changelogs docs: allow for Sphinx directives in changelogs Nov 25, 2019
blueyed
blueyed commented Nov 25, 2019
View reviewed changes
RonnyPfannschmidt
RonnyPfannschmidt approved these changes Nov 25, 2019
View reviewed changes
Copy link
Member

@RonnyPfannschmidt RonnyPfannschmidt left a comment

Choose a reason for hiding this comment

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

lovely setup

@blueyed blueyed changed the title docs: allow for Sphinx directives in changelogs [WIP/RFC] docs: allow for Sphinx directives in changelogs Nov 25, 2019
@blueyed blueyed changed the title [WIP/RFC] docs: allow for Sphinx directives in changelogs docs: allow for Sphinx directives in changelogs Nov 25, 2019
@blueyed blueyed mentioned this pull request Nov 25, 2019
Merged
@blueyed blueyed mentioned this pull request Nov 27, 2019
Merged
@blueyed blueyed closed this Nov 27, 2019
@blueyed
Copy link
Contributor Author

blueyed commented Nov 27, 2019

@RonnyPfannschmidt I think @nicoddemus should do a new PR with the conflicts being resolved there.

@blueyed blueyed closed this Nov 27, 2019
@blueyed blueyed deleted the docs branch November 27, 2019 13:07
@blueyed blueyed restored the docs branch November 28, 2019 00:26
nicoddemus pushed a commit to nicoddemus/pytest that referenced this pull request Nov 28, 2019
@blueyed @nicoddemus
docs: move changelog to docs/en and allow sphinx directives
3d143f2 
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
nicoddemus pushed a commit to nicoddemus/pytest that referenced this pull request Nov 28, 2019
@blueyed @nicoddemus
docs: move changelog to docs/en and allow sphinx directives
1dc19f3 
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
nicoddemus pushed a commit to nicoddemus/pytest that referenced this pull request Nov 28, 2019
@blueyed @nicoddemus
docs: move changelog to docs/en and allow sphinx directives
0f0af11 
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
nicoddemus pushed a commit to nicoddemus/pytest that referenced this pull request Nov 28, 2019
@blueyed @nicoddemus
docs: move changelog to docs/en and allow sphinx directives
a1240ad 
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
@nicoddemus nicoddemus mentioned this pull request Nov 28, 2019
Merged
nicoddemus pushed a commit to nicoddemus/pytest that referenced this pull request Nov 29, 2019
@blueyed @nicoddemus
docs: move changelog to docs/en and allow sphinx directives
d3ab56f 
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
vinaycalastry pushed a commit to vinaycalastry/pytest that referenced this pull request Dec 11, 2019
@blueyed @vinaycalastry
docs: move changelog to docs/en and allow sphinx directives
141624e 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RonnyPfannschmidt RonnyPfannschmidt RonnyPfannschmidt approved these changes

Assignees

@nicoddemus nicoddemus

Labels
type: docs documentation improvement, missing or needing clarification type: enhancement new feature or API change, should be merged into features branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

pre-commit: rst: allow pytest directives in changelog entries
3 participants
@blueyed @RonnyPfannschmidt @nicoddemus