Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(24)

Side by Side Diff: Doc/distutils/packageindex.rst

Issue 17311: use distutils terminology in "PyPI package display" section
Patch Set: Created 4 years, 9 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 .. index:: 1 .. index::
2 single: Python Package Index (PyPI) 2 single: Python Package Index (PyPI)
3 single: PyPI; (see Python Package Index (PyPI)) 3 single: PyPI; (see Python Package Index (PyPI))
4 4
5 .. _package-index: 5 .. _package-index:
6 6
7 ******************************* 7 *******************************
8 The Python Package Index (PyPI) 8 The Python Package Index (PyPI)
9 ******************************* 9 *******************************
10 10
(...skipping 193 matching lines...) Expand 10 before | Expand all | Expand 10 after
204 <https://wiki.python.org/moin/TestPyPI>`_ to your ``.pypirc`` to facilitate 204 <https://wiki.python.org/moin/TestPyPI>`_ to your ``.pypirc`` to facilitate
205 testing before doing your first upload to ``PyPI`` itself. 205 testing before doing your first upload to ``PyPI`` itself.
206 206
207 207
208 .. _package-display: 208 .. _package-display:
209 209
210 PyPI package display 210 PyPI package display
211 ==================== 211 ====================
212 212
213 The ``long_description`` field plays a special role at PyPI. It is used by 213 The ``long_description`` field plays a special role at PyPI. It is used by
214 the server to display a home page for the registered package. 214 the server to display a distribution page for the registered distribution packag e.
215 215
216 If you use the `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ 216 If you use the `reStructuredText <http://docutils.sourceforge.net/rst.html>`_
217 syntax for this field, PyPI will parse it and display an HTML output for 217 syntax for this field, PyPI will parse it and display an HTML output for
218 the package home page. 218 the package distribution page.
219 219
220 The ``long_description`` field can be attached to a text file located 220 The ``long_description`` field can be attached to a text file located
221 in the package:: 221 in the package::
222 222
223 from distutils.core import setup 223 from distutils.core import setup
224 224
225 with open('README.txt') as file: 225 with open('README.txt') as file:
226 long_description = file.read() 226 long_description = file.read()
227 227
228 setup(name='Distutils', 228 setup(name='Distutils',
229 long_description=long_description) 229 long_description=long_description)
230 230
231 In that case, :file:`README.txt` is a regular reStructuredText text file located 231 In that case, :file:`README.txt` is a regular reStructuredText text file located
232 in the root of the package besides :file:`setup.py`. 232 in the root of the package besides :file:`setup.py`.
233 233
234 To prevent registering broken reStructuredText content, you can use the 234 To prevent registering broken reStructuredText content, you can use the
235 :program:`rst2html` program that is provided by the :mod:`docutils` package and 235 :program:`rst2html` program that is provided by the :mod:`docutils` package and
236 check the ``long_description`` from the command line:: 236 check the ``long_description`` from the command line::
237 237
238 $ python setup.py --long-description | rst2html.py > output.html 238 $ python setup.py --long-description | rst2html.py > output.html
239 239
240 :mod:`docutils` will display a warning if there's something wrong with your 240 :mod:`docutils` will display a warning if there's something wrong with your
241 syntax. Because PyPI applies additional checks (e.g. by passing ``--no-raw`` 241 syntax. Because PyPI applies additional checks (e.g. by passing ``--no-raw``
242 to ``rst2html.py`` in the command above), being able to run the command above 242 to ``rst2html.py`` in the command above), being able to run the command above
243 without warnings does not guarantee that PyPI will convert the content 243 without warnings does not guarantee that PyPI will convert the content
244 successfully. 244 successfully.
245 245
246 246
247 .. _Python Package Index (PyPI): https://pypi.python.org/pypi 247 .. _Python Package Index (PyPI): https://pypi.python.org/pypi
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+