From 4c36aa4108a15c990494ab3c6ab83634a774681f Mon Sep 17 00:00:00 2001 From: Eli Bendersky Date: Thu, 2 Aug 2012 03:00:33 +0300 Subject: Issue #15231: update PyPI upload doc to say --no-raw passed to rst2html.py --- Doc/distutils/uploading.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst index 936402b..12ee328 100644 --- a/Doc/distutils/uploading.rst +++ b/Doc/distutils/uploading.rst @@ -74,4 +74,9 @@ and check the ``long_description`` from the command line:: $ python setup.py --long-description | rst2html.py > output.html -:mod:`docutils` will display a warning if there's something wrong with your syntax. +: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), being able to run the command above +without warnings does not guarantee that PyPI will convert the content +successfully. + -- cgit v0.12