@@ -171,7 +171,8 @@ Bad example (creating worry in the mind of a reader):
171171 excessive resource consumption. Never rely on reference counting to
172172 automatically close a file.
173173
174- Good example (establishing confident knowledge in the effective use of the language):
174+ Good example (establishing confident knowledge in the effective use of the
175+ language):
175176
176177 A best practice for using files is use a try/finally pair to explicitly
177178 close a file after it is used. Alternatively, using a with-statement can
@@ -222,8 +223,8 @@ a typical use case. For instance, the :meth:`str.rpartition` method is better
222223demonstrated with an example splitting the domain from a URL than it would be
223224with an example of removing the last word from a line of Monty Python dialog.
224225
225- The ellipsis for the :py:data: `sys.ps2 ` secondary interpreter prompt should only be
226- used sparingly, where it is necessary to clearly differentiate between input
226+ The ellipsis for the :py:data: `sys.ps2 ` secondary interpreter prompt should only
227+ be used sparingly, where it is necessary to clearly differentiate between input
227228lines and output lines. Besides contributing visual clutter, it makes it
228229difficult for readers to cut-and-paste examples so they can experiment with
229230variations.
@@ -456,7 +457,9 @@ the extension mechanisms of reST, and Sphinx makes heavy use of it.
456457
457458Basically, a directive consists of a name, arguments, options and content. (Keep
458459this terminology in mind, it is used in the next chapter describing custom
459- directives.) Looking at this example, ::
460+ directives.) Looking at this example,
461+
462+ ::
460463
461464 .. function:: foo(x)
462465 foo(y, z)
@@ -853,8 +856,8 @@ Syntax highlighting is handled in a smart way:
853856
854857Longer displays of verbatim text may be included by storing the example text in
855858an external file containing only plain text. The file may be included using the
856- ``literalinclude `` directive. [1 ]_ For example, to include the Python source file
857- :file: `example.py `, use::
859+ ``literalinclude `` directive. [1 ]_ For example, to include the Python source
860+ file :file: `example.py `, use::
858861
859862 .. literalinclude:: example.py
860863
@@ -895,8 +898,8 @@ a matching identifier is found:
895898
896899.. describe :: mod
897900
898- The name of a module; a dotted name may be used. This should also be used for
899- package names.
901+ The name of a module; a dotted name may be used. This should also be used
902+ for package names.
900903
901904.. describe :: func
902905
@@ -1358,8 +1361,8 @@ pair
13581361 namely ``loop; statement `` and ``statement; loop ``.
13591362triple
13601363 Likewise, ``triple: module; search; path `` is a shortcut that creates three
1361- index entries, which are ``module; search path ``, ``search; path, module `` and
1362- ``path; module search ``.
1364+ index entries, which are ``module; search path ``, ``search; path, module ``
1365+ and ``path; module search ``.
13631366module, keyword, operator, object, exception, statement, builtin
13641367 These all create two index entries. For example, ``module: hashlib ``
13651368 creates the entries ``module; hashlib `` and ``hashlib; module ``. The
@@ -1418,8 +1421,8 @@ The following is an example taken from the Python Reference Manual::
14181421Substitutions
14191422-------------
14201423
1421- The documentation system provides three substitutions that are defined by default.
1422- They are set in the build configuration file :file: `conf.py `.
1424+ The documentation system provides three substitutions that are defined by
1425+ default. They are set in the build configuration file :file: `conf.py `.
14231426
14241427.. describe :: |release|
14251428
@@ -1491,7 +1494,7 @@ Without make
14911494
14921495Install the Sphinx package and its dependencies from PyPI.
14931496
1494- Then, from the ``Docs `` directory, run ::
1497+ Then, from the ``Docs `` directory, run::
14951498
14961499 sphinx-build -b<builder> . build/<builder>
14971500
0 commit comments