diff options
author | Martin Panter <vadmium+py@gmail.com> | 2016-07-26 09:18:21 (GMT) |
---|---|---|
committer | Martin Panter <vadmium+py@gmail.com> | 2016-07-26 09:18:21 (GMT) |
commit | 1050d2d0c7730c6c533246bb2404937739a7775c (patch) | |
tree | 68d901cd196aead4df7c3b074ebf2df6e85678e7 /Doc/distutils | |
parent | 87ec85f4208bf329e6454fd3e2639c613b2b61af (diff) | |
download | cpython-1050d2d0c7730c6c533246bb2404937739a7775c.zip cpython-1050d2d0c7730c6c533246bb2404937739a7775c.tar.gz cpython-1050d2d0c7730c6c533246bb2404937739a7775c.tar.bz2 |
Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
Diffstat (limited to 'Doc/distutils')
-rw-r--r-- | Doc/distutils/examples.rst | 12 | ||||
-rw-r--r-- | Doc/distutils/packageindex.rst | 4 | ||||
-rw-r--r-- | Doc/distutils/sourcedist.rst | 4 |
3 files changed, 15 insertions, 5 deletions
diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst index af9125a..1f5be9c 100644 --- a/Doc/distutils/examples.rst +++ b/Doc/distutils/examples.rst @@ -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 diff --git a/Doc/distutils/packageindex.rst b/Doc/distutils/packageindex.rst index 2d7daef..28ad128 100644 --- a/Doc/distutils/packageindex.rst +++ b/Doc/distutils/packageindex.rst @@ -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 diff --git a/Doc/distutils/sourcedist.rst b/Doc/distutils/sourcedist.rst index fb70514..35aea1e 100644 --- a/Doc/distutils/sourcedist.rst +++ b/Doc/distutils/sourcedist.rst @@ -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 |