Skip to content

Commit f37c0c7

Browse files
committed
Issue #15321: update PyPI upload doc to say --no-raw passed to rst2html.py
1 parent 4c1730d commit f37c0c7

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

Doc/distutils/uploading.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,8 @@ check the ``long_description`` from the command line::
7373
$ python setup.py --long-description | rst2html.py > output.html
7474

7575
:mod:`docutils` will display a warning if there's something wrong with your
76-
syntax.
76+
syntax. Because PyPI applies additional checks (e.g. by passing ``--no-raw``
77+
to ``rst2html.py`` in the command above), being able to run the command above
78+
without warnings does not guarantee that PyPI will convert the content
79+
successfully.
80+

0 commit comments

Comments
 (0)