Skip to content

Commit cbd0594

Browse files
committed
docs: add section "Table of Contents"
1 parent 354dc67 commit cbd0594

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

contributing/documentation.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,6 @@ Markdown or Textile, you will quickly grasp reStructuredText. The focus is
88
on readability and user friendliness.
99
While they can be quite technical, we always write for humans!
1010

11-
A local table of contents should always be included, like the one below.
12-
It is created automatically by inserting the following::
13-
14-
.. contents::
15-
:local:
16-
:depth: 2
1711

1812
.. contents::
1913
:local:
@@ -28,6 +22,17 @@ is to have Python installed.
2822

2923
You can read more about installing all tools in /user_guide_src/README.rst
3024

25+
*****************
26+
Table of Contents
27+
*****************
28+
29+
A local table of contents should always be included, like the one below.
30+
It is created automatically by inserting the following::
31+
32+
.. contents::
33+
:local:
34+
:depth: 2
35+
3136
*****************************************
3237
Page and Section Headings and Subheadings
3338
*****************************************

0 commit comments

Comments
 (0)