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/README.rst | |
| 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/README.rst')
| -rw-r--r-- | doc/sphinx/README.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/sphinx/README.rst b/doc/sphinx/README.rst index 32de15ee31..1643baf0e8 100644 --- a/doc/sphinx/README.rst +++ b/doc/sphinx/README.rst @@ -239,6 +239,9 @@ In addition to the objects above, the ``coqrst`` Sphinx plugin defines the follo http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic-admonition for more details. + Optionally, any text immediately following the ``.. example::`` header is + used as the example's title. + Example:: .. example:: Adding a hint to a database |