Skip to content

Commit 3deb16e

Browse files
committed
Demodocs: Cleanup, text wrapping
1 parent 4aaaff4 commit 3deb16e

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

demo_docs/source/demo.rst

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,24 @@ Paragraph Level Markup
1212
Inline Markup
1313
=============
1414

15-
Paragraphs contain text and may contain inline markup: *emphasis*,
16-
**strong emphasis**, ``inline literals``, standalone hyperlinks
17-
(http://www.python.org), external hyperlinks (Python_), internal
18-
cross-references (example_), external hyperlinks with embedded URIs
19-
(`Python web site <http://www.python.org>`__), footnote references
20-
(manually numbered [1]_, anonymous auto-numbered [#]_, labeled
21-
auto-numbered [#label]_, or symbolic [*]_), citation references
22-
([2]_), substitution references (|example|), and _`inline hyperlink targets`
23-
(see Targets_ below for a reference back to here).
24-
Character-level inline markup is also possible (although exceedingly ugly!)
25-
in *re*\ ``Structured``\ *Text*. Problems are indicated by |problematic| text
26-
(generated by processing errors; this one is intentional).
27-
28-
Also with ``sphinx.ext.autodoc``, which I use in the demo,
29-
I can link to :class:`test_py_module.test.Foo`.
15+
Paragraphs contain text and may contain inline markup: *emphasis*, **strong emphasis**, ``inline literals``,
16+
standalone hyperlinks (http://www.python.org), external hyperlinks (Python_), internal cross-references (example_),
17+
external hyperlinks with embedded URIs (`Python web site <http://www.python.org>`__), footnote references
18+
(manually numbered [1]_, anonymous auto-numbered [#]_, labeled auto-numbered [#label]_, or symbolic [*]_),
19+
citation references ([2]_), substitution references (|example|), and _`inline hyperlink targets`
20+
(see Targets_ below for a reference back to here). Character-level inline markup is also possible
21+
(although exceedingly ugly!) in *re*\ ``Structured``\ *Text*. Problems are indicated by |problematic|
22+
text (generated by processing errors; this one is intentional).
23+
24+
Also with ``sphinx.ext.autodoc``, which I use in the demo, I can link to :class:`test_py_module.test.Foo`.
3025
It will link you right my code documentation for it.
3126

32-
The default role for interpreted text is `Title Reference`. Here are
33-
some explicit interpreted text roles: a PEP reference (:PEP:`287`); an
34-
RFC reference (:RFC:`2822`); a :sub:`subscript`; a :sup:`superscript`;
27+
The default role for interpreted text is `Title Reference`. Here are some explicit interpreted text roles:
28+
a PEP reference (:PEP:`287`); an RFC reference (:RFC:`2822`); a :sub:`subscript`; a :sup:`superscript`;
3529
and explicit roles for :emphasis:`standard` :strong:`inline` :literal:`markup`.
3630

37-
GUI labels are a useful way to indicate that :guilabel:`Some action` is
38-
to be taken by the user. The GUI label should not run over
39-
``line-height`` so as not to :guilabel:`interfere` with text from adjacent lines.
31+
GUI labels are a useful way to indicate that :guilabel:`Some action` is to be taken by the user.
32+
The GUI label should not run over ``line-height`` so as not to :guilabel:`interfere` with text from adjacent lines.
4033

4134
Key-bindings indicate that the read is to press a button on the keyboard or mouse,
4235
for example :kbd:`MMB` and :kbd:`Shift-MMB`. Another useful markup to indicate a user action

0 commit comments

Comments
 (0)