seealso¶
seealso is one of specific admonitions. They are all visually bold blocks often rendered in colors according to their type. seealso is suitable to list links to another documents or external URLs.
Content on the same line¶
Short text can be typed right after seealso:: (note the space after ::).
1.. seealso:: List of admonitions.
See also
List of admonitions.
Content bellow the directive¶
For longer text more fits to put it the line bellow.
1.. seealso::
2 List of admonitions.
See also
List of admonitions.
Content bellow the directive with blank line¶
Optionally, you can place a blank line before the text itself.
1.. seealso::
2
3 List of admonitions.
See also
List of admonitions.
Directive name in uppercase¶
Directive name is case insensitive (like all directive and role names). Most documentation and book authors prefer typing directives and roles all in lowercase. However, writing directive name in uppercase corresponds with their “raise attention” objective and improves reStructuredText code readability.
1.. SEEALSO:: However writing admonitions uppercase can be considered as reasonable exception to "all-lowercase" rule.
See also
However writing admonitions uppercase can be considered as reasonable exception to “all-lowercase” rule.
Complex content¶
Any reStructuredText elements can be in admonition content. As always, you need only to keep correct indentation.
1.. seealso::
2
3 This is the admonition with complex body containing
4
5 - two items
6 - bullet list
7
8 And, code example::
9
10 $ nano ~/.bash_aliases
See also
This is the admonition with complex body containing
two items
bullet list
And, code example:
$ nano ~/.bash_aliases