This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Check well-formedness of reST markup within "make patchcheck"
Type: enhancement Stage: resolved
Components: Demos and Tools Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: out of date
Dependencies: Superseder:
Assigned To: Nosy List: Mariatta, cheryl.sabella, dmalcolm, eric.araujo, ezio.melotti, georg.brandl
Priority: normal Keywords:

Created on 2010-11-22 16:29 by dmalcolm, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (6)
msg122142 - (view) Author: Dave Malcolm (dmalcolm) (Python committer) Date: 2010-11-22 16:29
Misc/NEWS needs to be valid reST.

Issue 10450 identified an issue where it wasn't.

"make patchcheck" potentially could check the markup of that file, and, potentially all the other places in the source tree that are supposed to be valid reST (all of the .rst files in the source tree, especially those below Doc).

I don't know what the best way of doing this is, without pulling in a lot of dependencies.  (Perhaps we could look for rst2html on $PATH, and use it if it's present?).
msg122496 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-11-27 01:41
Have a look at Doc/tools/rstlint.py
msg122646 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-11-28 10:37
rst2html doesn't help, since it doesn't recognize Sphinx' and Python's own markup extensions.
msg148269 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-11-24 16:09
Alternatively, make patchcheck could print “Did you build the docs?”, just as it currently prints “Did you run the test suite?” if C or Python files were modified.  Building the docs would not check Misc/NEWS, the original motivation for this request, but I’m not sure it’s a big issue.
msg313115 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2018-03-01 22:24
Since `blurb` says to write a simple ReST paragraph and that is code reviewed with the PR, is this issue still needed?
msg313124 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2018-03-02 03:54
This is out of date. I'm closing it.

Thanks.
History
Date User Action Args
2022-04-11 14:57:09adminsetgithub: 54716
2018-03-02 03:54:49Mariattasetstatus: open -> closed

nosy: + Mariatta
messages: + msg313124

resolution: out of date
stage: needs patch -> resolved
2018-03-01 22:24:35cheryl.sabellasetnosy: + cheryl.sabella
messages: + msg313115
2011-11-24 19:01:04ezio.melottisetnosy: + ezio.melotti

versions: - Python 3.1
2011-11-24 16:09:31eric.araujosetmessages: + msg148269
2010-11-28 10:37:55georg.brandlsetnosy: + georg.brandl
messages: + msg122646
2010-11-27 01:41:20eric.araujosetnosy: + eric.araujo
messages: + msg122496
2010-11-22 16:29:25dmalcolmcreate