summaryrefslogtreecommitdiffstats
path: root/Doc/distutils
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-03-12 10:06:40 (GMT)
committerGeorg Brandl <georg@python.org>2010-03-12 10:06:40 (GMT)
commitef871f6160db0bd5475cc4721c90788d85cb4f95 (patch)
tree04b22816a71d25439f8ed2506985055fee490158 /Doc/distutils
parent420ca77e7340d0cc33ba0dc0afc36b42560b0104 (diff)
downloadcpython-ef871f6160db0bd5475cc4721c90788d85cb4f95.zip
cpython-ef871f6160db0bd5475cc4721c90788d85cb4f95.tar.gz
cpython-ef871f6160db0bd5475cc4721c90788d85cb4f95.tar.bz2
Merged revisions 78859-78860 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r78859 | georg.brandl | 2010-03-12 10:57:43 +0100 (Fr, 12 Mär 2010) | 1 line Get rid of backticks. ........ r78860 | georg.brandl | 2010-03-12 11:02:03 +0100 (Fr, 12 Mär 2010) | 1 line Fix warnings from "make check". ........
Diffstat (limited to 'Doc/distutils')
-rw-r--r--Doc/distutils/examples.rst16
-rw-r--r--Doc/distutils/uploading.rst8
2 files changed, 12 insertions, 12 deletions
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst
index 60656e7..a5a0239 100644
--- a/Doc/distutils/examples.rst
+++ b/Doc/distutils/examples.rst
@@ -257,9 +257,9 @@ Running the ``check`` command will display some warnings::
(maintainer and maintainer_email) must be supplied
-If you use the reStructuredText syntax in the `long_description` field and
+If you use the reStructuredText syntax in the ``long_description`` field and
`docutils <http://docutils.sourceforge.net/>`_ is installed you can check if
-the syntax is fine with the ``check`` command, using the `restructuredtext`
+the syntax is fine with the ``check`` command, using the ``restructuredtext``
option.
For example, if the :file:`setup.py` script is changed like this::
@@ -278,7 +278,7 @@ For example, if the :file:`setup.py` script is changed like this::
url='http://example.com', long_description=desc)
Where the long description is broken, ``check`` will be able to detect it
-by using the `docutils` parser::
+by using the :mod:`docutils` parser::
$ pythontrunk setup.py check --restructuredtext
running check
@@ -293,20 +293,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::
+:file:`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
diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst
index e947245..7b790b1 100644
--- a/Doc/distutils/uploading.rst
+++ b/Doc/distutils/uploading.rst
@@ -60,13 +60,13 @@ in the package::
setup(name='Distutils',
long_description=open('README.txt'))
-In that case, `README.txt` is a regular reStructuredText text file located
-in the root of the package besides `setup.py`.
+In that case, :file:`README.txt` is a regular reStructuredText text file located
+in the root of the package besides :file:`setup.py`.
To prevent registering broken reStructuredText content, you can use the
-:program:`rst2html` program that is provided by the `docutils` package
+:program:`rst2html` program that is provided by the :mod:`docutils` package
and check the ``long_description`` from the command line::
$ python setup.py --long-description | rst2html.py > output.html
-`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.