summaryrefslogtreecommitdiffstats
path: root/Doc/distutils
diff options
context:
space:
mode:
authorSenthil Kumaran <orsenthil@gmail.com>2010-10-15 13:29:33 (GMT)
committerSenthil Kumaran <orsenthil@gmail.com>2010-10-15 13:29:33 (GMT)
commit8227045bbe2db3386b9c2ac4d0e73a02c9b4a95a (patch)
treec473fdfec0b1366b9d34283a7b6d1a83adc3c407 /Doc/distutils
parent46a48bef3f0351f8f4b8c709b34537e0b6be752d (diff)
downloadcpython-8227045bbe2db3386b9c2ac4d0e73a02c9b4a95a.zip
cpython-8227045bbe2db3386b9c2ac4d0e73a02c9b4a95a.tar.gz
cpython-8227045bbe2db3386b9c2ac4d0e73a02c9b4a95a.tar.bz2
Fix sphinx role markups.
Diffstat (limited to 'Doc/distutils')
-rw-r--r--Doc/distutils/examples.rst10
-rw-r--r--Doc/distutils/uploading.rst11
2 files changed, 11 insertions, 10 deletions
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst
index 648063b..e31ff72 100644
--- a/Doc/distutils/examples.rst
+++ b/Doc/distutils/examples.rst
@@ -257,10 +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
-`docutils <http://docutils.sourceforge.net/>`_ is installed you can check if
-the syntax is fine with the ``check`` command, using the `restructuredtext`
-option.
+If you use the reStructuredText syntax in the ``long_description`` field and
+`docutils`_ is installed you can check if 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 +277,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
@@ -291,3 +290,4 @@ by using the `docutils` parser::
.. % \section{Putting it all together}
+.. _docutils: http://docutils.sourceforge.net
diff --git a/Doc/distutils/uploading.rst b/Doc/distutils/uploading.rst
index e947245..68c1e52 100644
--- a/Doc/distutils/uploading.rst
+++ b/Doc/distutils/uploading.rst
@@ -60,13 +60,14 @@ 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
-and check the ``long_description`` from the command line::
+: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.