]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Fix sphinx role markups.
authorSenthil Kumaran <orsenthil@gmail.com>
Fri, 15 Oct 2010 13:29:33 +0000 (13:29 +0000)
committerSenthil Kumaran <orsenthil@gmail.com>
Fri, 15 Oct 2010 13:29:33 +0000 (13:29 +0000)
Doc/distutils/examples.rst
Doc/distutils/uploading.rst
Doc/library/email.message.rst
Doc/whatsnew/3.2.rst

index 648063b2176726e94eabf887dc5ffac4c934903e..e31ff729174799a5526c5a241244305a10b81ed0 100644 (file)
@@ -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
index e9472453d3039a17e752bc468ed3508f865177a2..68c1e52d56c9da85d3b15de748cc82694f10335b 100644 (file)
@@ -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.
index dc305a7fd8b07081158a0d49e4447d57ed0dcf9a..47c1fcde0379cc7a2922df836efbfbeaa6e04ab7 100644 (file)
@@ -118,10 +118,11 @@ Here are the methods of the :class:`Message` class:
       When *decode* is ``False`` (the default) the body is returned as a string
       without decoding the :mailheader:`Content-Transfer-Encoding`.  However,
       for a :mailheader:`Content-Transfer-Encoding` of 8bit, an attempt is made
-      to decode the original bytes using the `charset` specified by the
-      :mailheader:`Content-Type` header, using the `replace` error handler.  If
-      no `charset` is specified, or if the `charset` given is not recognized by
-      the email package, the body is decoded using the default ASCII charset.
+      to decode the original bytes using the ``charset`` specified by the
+      :mailheader:`Content-Type` header, using the ``replace`` error handler.
+      If no ``charset`` is specified, or if the ``charset`` given is not
+      recognized by the email package, the body is decoded using the default
+      ASCII charset.
 
 
    .. method:: set_payload(payload, charset=None)
index 9ac966d64d161d79e70d1bd355c1b03e6867b8fa..0d9b96884c18d4425b87b6fe8d669d790fd0416f 100644 (file)
@@ -197,8 +197,8 @@ in bytes format.
 
 * Given bytes input to the model, :meth:`~email.message.Message.get_payload`
   will by default decode a message body that has a
-  :mailheader:`Content-Transfer-Encoding` of `8bit` using the charset specified
-  in the MIME headers and return the resulting string.
+  :mailheader:`Content-Transfer-Encoding` of ``8bit`` using the charset
+  specified in the MIME headers and return the resulting string.
 
 * Given bytes input to the model, :class:`~email.generator.Generator` will
   convert message bodies that have a :mailheader:`Content-Transfer-Encoding` of