Skip to content

Commit 81743ff

Browse files
committed
Update markup for structure
1 parent 94c6bac commit 81743ff

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

documenting/markup.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ reStructuredText Markup
66

77
.. highlight:: rest
88

9+
This document describes the custom reStructuredText markup introduced by Sphinx
10+
to support Python documentation and how it should be used.
11+
912

1013
.. _rst-primer:
1114

@@ -190,7 +193,8 @@ A directive is a generic block of explicit markup. Besides roles, it is one of
190193
the extension mechanisms of reST, and Sphinx makes heavy use of it.
191194

192195
Basically, a directive consists of a name, arguments, options and content. (Keep
193-
this terminology in mind, it is used in the next chapter describing custom
196+
this terminology in mind, it is used in `:ref:`the next section
197+
<Additional Markup Constructs>` describing custom
194198
directives.) Looking at this example,
195199

196200
::

documenting/start-documenting.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@ contributed by various authors. The markup used for the Python documentation is
1111
`reStructuredText`_, developed by the `docutils`_ project, amended by custom
1212
directives and using a toolset named `Sphinx`_ to post-process the HTML output.
1313

14-
This document describes the style guide for our documentation as well as the
15-
custom reStructuredText markup introduced by Sphinx to support Python
16-
documentation and how it should be used.
14+
This document describes the style guide for our documentation.
1715

1816
The documentation in HTML, PDF or EPUB format is generated from text files
1917
written using the :ref:`reStructuredText format <markup>` and contained in the

0 commit comments

Comments
 (0)