mirror of
https://github.com/python/cpython.git
synced 2025-11-01 18:51:43 +00:00
Fix sphinx role markups.
This commit is contained in:
parent
46a48bef3f
commit
8227045bbe
4 changed files with 18 additions and 16 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue