[Python-checkins] r85521 - in python/branches/py3k/Doc: distutils/examples.rst distutils/uploading.rst library/email.message.rst whatsnew/3.2.rst

senthil.kumaran python-checkins at python.org
Fri Oct 15 15:29:33 CEST 2010


Author: senthil.kumaran
Date: Fri Oct 15 15:29:33 2010
New Revision: 85521

Log:
Fix sphinx role markups.



Modified:
   python/branches/py3k/Doc/distutils/examples.rst
   python/branches/py3k/Doc/distutils/uploading.rst
   python/branches/py3k/Doc/library/email.message.rst
   python/branches/py3k/Doc/whatsnew/3.2.rst

Modified: python/branches/py3k/Doc/distutils/examples.rst
==============================================================================
--- python/branches/py3k/Doc/distutils/examples.rst	(original)
+++ python/branches/py3k/Doc/distutils/examples.rst	Fri Oct 15 15:29:33 2010
@@ -257,10 +257,9 @@
              (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 @@
         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 @@
 .. % \section{Putting it all together}
 
 
+.. _docutils: http://docutils.sourceforge.net

Modified: python/branches/py3k/Doc/distutils/uploading.rst
==============================================================================
--- python/branches/py3k/Doc/distutils/uploading.rst	(original)
+++ python/branches/py3k/Doc/distutils/uploading.rst	Fri Oct 15 15:29:33 2010
@@ -60,13 +60,14 @@
     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.

Modified: python/branches/py3k/Doc/library/email.message.rst
==============================================================================
--- python/branches/py3k/Doc/library/email.message.rst	(original)
+++ python/branches/py3k/Doc/library/email.message.rst	Fri Oct 15 15:29:33 2010
@@ -118,10 +118,11 @@
       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)

Modified: python/branches/py3k/Doc/whatsnew/3.2.rst
==============================================================================
--- python/branches/py3k/Doc/whatsnew/3.2.rst	(original)
+++ python/branches/py3k/Doc/whatsnew/3.2.rst	Fri Oct 15 15:29:33 2010
@@ -197,8 +197,8 @@
 
 * 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


More information about the Python-checkins mailing list