[Python-checkins] cpython (2.7): Issue #15231: update PyPI upload doc to say --no-raw passed to rst2html.py

[eli.bendersky]

http://hg.python.org/cpython/rev/29bdbcadf299
changeset:   78378:29bdbcadf299
branch:      2.7
parent:      78365:5a8c5631463f
user:        Eli Bendersky <eliben at gmail.com>
date:        Thu Aug 02 03:00:33 2012 +0300
summary:
  Issue #15231: update PyPI upload doc to say --no-raw passed to rst2html.py

files:
  Doc/distutils/uploading.rst |  7 ++++++-
  1 files changed, 6 insertions(+), 1 deletions(-)


diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst
--- a/Doc/distutils/uploading.rst
+++ b/Doc/distutils/uploading.rst
@@ -74,4 +74,9 @@
 
     $ 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.
+

-- 
Repository URL: http://hg.python.org/cpython