Check news fragments to confirm they are valid ReST

[pfmoore]

It's very easy for people writing a PR to use Markdown for the news fragments, without thinking (in particular using single ` characters rather than double for code). Because the news file is generated on release, this isn't picked up by the doc build checks.

We should add a test that checks news fragments are valid ReST.

[pradyunsg]

This'll need to happen over at pypa/browntruck. I feel you should probably file an issue there for this.

[pfmoore]

I was thinking more of adding a test that just ran news/* through some sort of ReST checker. Or even add such a test to the docs tox step.

But I guess browntruck might be another approach - I've never looked at how that works.

[pradyunsg]

Sorry for the tone of the last comment. I was just very sure this should be a browntruck thing. This could just be a part of the news check to be honest.

Ideally, we should get that browntruck repo renamed to pypa-bot or something and document that a little more nicely. :P

The approaches you suggest also make sense but I do feel the CI check also checking this would be cleaner.

Here's the relavent class: https://github.com/pypa/browntruck/blob/twisted/browntruck/hooks/news.py#L46

[dstufft]

One benefit of having it be part of the test suite rather than part of browntruck, is that contributors can run the verification locally instead of having to push to the branch and trigger a full test suite run to see if they've fixed the errors.

[pradyunsg]

Consider me convinced to add this to the test suite. :)

(on mobile, sorry for terseness)