diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst --- a/Doc/distutils/uploading.rst +++ b/Doc/distutils/uploading.rst @@ -74,5 +74,6 @@ :mod:`docutils` will display a warning if there's something wrong with your syntax. Because PyPI applies additional checks (e.g. by passing ``--no-raw`` -to ``rst2html.py`` in the command above), running the command above without -warnings is not sufficient for PyPI to convert the content successfully. +to ``rst2html.py`` in the command above), being able to run the command above +without warnings is not sufficient to be sure that PyPI will convert the +content successfully. diff --git a/Misc/NEWS b/Misc/NEWS --- a/Misc/NEWS +++ b/Misc/NEWS @@ -213,6 +213,10 @@ Documentation ------------- +- Issue #15231: Update the "PyPI package display" documentation to say that + running rst2html.py without warnings does not guarantee conversion to HTML. + Patch by Chris Jerdonek. + - Issue #15230: Clearly document some of the limitations of the runpy module and nudge readers towards importlib when appropriate.