diff options
| author | Clément Pit-Claudel | 2018-07-30 15:14:53 -0400 |
|---|---|---|
| committer | Clément Pit-Claudel | 2018-07-30 15:16:25 -0400 |
| commit | 7f1ed3298c841c2afa4faf080a5f65361bbb413f (patch) | |
| tree | b3917392b1b07818f07bb7d9b39cdc628b3e539e /doc/sphinx/practical-tools | |
| parent | 1b2decc1bc0db2a58fcc4a4e6e572aed645bab29 (diff) | |
[sphinx] Use arguments of '.. example::' directive as a title
Most existing uses of .. example did not use the first line as a title, so this
commit also adds appropriate blank lines.
Diffstat (limited to 'doc/sphinx/practical-tools')
| -rw-r--r-- | doc/sphinx/practical-tools/utilities.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/sphinx/practical-tools/utilities.rst b/doc/sphinx/practical-tools/utilities.rst index e15bcb8e2c..59bc2d22aa 100644 --- a/doc/sphinx/practical-tools/utilities.rst +++ b/doc/sphinx/practical-tools/utilities.rst @@ -218,6 +218,7 @@ file timing data: On ``Mac OS``, this works best if you’ve installed ``gnu-time``. .. example:: + For example, the output of ``make TIMED=1`` may look like this: @@ -295,6 +296,7 @@ file timing data: files which take effectively no time to compile. .. example:: + For example, the output table from ``make print-pretty-timed-diff`` may look like this: @@ -318,6 +320,7 @@ line timing data: line-by-line timing information. .. example:: + For example, running ``make all TIMING=1`` may result in a file like this: :: @@ -345,6 +348,7 @@ line timing data: This target requires python to build the table. .. example:: + For example, running ``print-pretty-single-time-diff`` might give a table like this: :: |
