mirror of
https://github.com/python/cpython.git
synced 2025-07-31 07:04:42 +00:00
Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
This commit is contained in:
parent
87ec85f420
commit
1050d2d0c7
47 changed files with 329 additions and 128 deletions
|
@ -245,7 +245,9 @@ Let's take an example with a simple script::
|
|||
|
||||
setup(name='foobar')
|
||||
|
||||
Running the ``check`` command will display some warnings::
|
||||
Running the ``check`` command will display some warnings:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ python setup.py check
|
||||
running check
|
||||
|
@ -274,7 +276,9 @@ 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 :mod:`docutils` parser::
|
||||
by using the :mod:`docutils` parser:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ python setup.py check --restructuredtext
|
||||
running check
|
||||
|
@ -286,7 +290,9 @@ 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::
|
||||
``setup.py`` script of a given project:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ python setup.py --name
|
||||
distribute
|
||||
|
|
|
@ -233,7 +233,9 @@ 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 :mod:`docutils` package and
|
||||
check the ``long_description`` from the command line::
|
||||
check the ``long_description`` from the command line:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ python setup.py --long-description | rst2html.py > output.html
|
||||
|
||||
|
|
|
@ -133,7 +133,9 @@ described above does not apply in this case.
|
|||
|
||||
The manifest template has one command per line, where each command specifies a
|
||||
set of files to include or exclude from the source distribution. For an
|
||||
example, again we turn to the Distutils' own manifest template::
|
||||
example, again we turn to the Distutils' own manifest template:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
include *.txt
|
||||
recursive-include examples *.txt *.py
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue