diff options
| author | Georg Brandl <georg@python.org> | 2010-04-17 10:29:14 +0200 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-04-17 10:29:14 +0200 |
| commit | ea85d7fb1fdad1fbac214c2653daf388738c3935 (patch) | |
| tree | aa3ae6c30991f1c6e465a2882e71560fdc5a65c8 /doc | |
| parent | c0ab2b5272d34b6fc9ffd83d8beb722d881aa80b (diff) | |
| download | sphinx-ea85d7fb1fdad1fbac214c2653daf388738c3935.tar.gz | |
Cleanup trailing whitespace and fix a few nits with the rst domain.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/domains.rst | 42 |
1 files changed, 27 insertions, 15 deletions
diff --git a/doc/domains.rst b/doc/domains.rst index a679e4da..d8f6515c 100644 --- a/doc/domains.rst +++ b/doc/domains.rst @@ -599,38 +599,50 @@ These roles are provided to refer to the described objects: js:data js:attr + The reStructuredText domain --------------------------- -The reStructuredText domain (**rst**) provides the following directives: +The reStructuredText domain (name **rst**) provides the following directives: .. directive:: .. rst:directive:: name - Describes a reST directive. The directive syntax (`..` prefix and - `::` suffix) is optional and will be automatically added if not - present. For example:: + Describes a reST directive. The *name* can be a single directive name or + actual directive syntax (`..` prefix and `::` suffix) with arguments that + will be rendered differently. For example:: .. rst:directive:: foo - + + Foo description. + .. rst:directive:: .. bar:: baz - + + Bar description. + will be rendered as: - + .. rst:directive:: foo - + + Foo description. + .. rst:directive:: .. bar:: baz + Bar description. + .. directive:: .. rst:role:: name - - Describes a reST role. For example:: - + + Describes a reST role. For example:: + .. rst:role:: foo - - + + Foo description. + will be rendered as: - + .. rst:role:: foo - + + Foo description. + These roles are provided to refer to the described objects: .. rst:role:: rst:dir |
