diff options
author | Georg Brandl <georg@python.org> | 2014-10-30 21:25:41 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2014-10-30 21:25:41 (GMT) |
commit | 93a56cdc3798f66f82f8c3d538b479df8931752e (patch) | |
tree | 31b5320243b711763d7e5a92db2a2744188e0f9c /Doc/distutils | |
parent | aea7f4a8e27a2f3a512a9cafbee25e00247f548b (diff) | |
download | cpython-93a56cdc3798f66f82f8c3d538b479df8931752e.zip cpython-93a56cdc3798f66f82f8c3d538b479df8931752e.tar.gz cpython-93a56cdc3798f66f82f8c3d538b479df8931752e.tar.bz2 |
Doc: fix default role usage (except in unittest mock docs)
Diffstat (limited to 'Doc/distutils')
-rw-r--r-- | Doc/distutils/examples.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst index b08e023..2ca76a0 100644 --- a/Doc/distutils/examples.rst +++ b/Doc/distutils/examples.rst @@ -286,20 +286,20 @@ Reading the metadata The :func:`distutils.core.setup` function provides a command-line interface that allows you to query the metadata fields of a project through the -`setup.py` script of a given project:: +``setup.py`` script of a given project:: $ python setup.py --name distribute -This call reads the `name` metadata by running the +This call reads the ``name`` metadata by running the :func:`distutils.core.setup` function. Although, when a source or binary distribution is created with Distutils, the metadata fields are written in a static file called :file:`PKG-INFO`. When a Distutils-based project is installed in Python, the :file:`PKG-INFO` file is copied alongside the modules and packages of the distribution under :file:`NAME-VERSION-pyX.X.egg-info`, -where `NAME` is the name of the project, `VERSION` its version as defined -in the Metadata, and `pyX.X` the major and minor version of Python like -`2.7` or `3.2`. +where ``NAME`` is the name of the project, ``VERSION`` its version as defined +in the Metadata, and ``pyX.X`` the major and minor version of Python like +``2.7`` or ``3.2``. You can read back this static file, by using the :class:`distutils.dist.DistributionMetadata` class and its |