mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add example for comments.
This commit is contained in:
12
doc/rest.rst
12
doc/rest.rst
@@ -291,7 +291,17 @@ Comments
|
|||||||
--------
|
--------
|
||||||
|
|
||||||
Every explicit markup block which isn't a valid markup construct (like the
|
Every explicit markup block which isn't a valid markup construct (like the
|
||||||
footnotes above) is regarded as a comment.
|
footnotes above) is regarded as a comment. For example::
|
||||||
|
|
||||||
|
.. This is a comment.
|
||||||
|
|
||||||
|
You can indent text after a comment start to form multiline comments::
|
||||||
|
|
||||||
|
..
|
||||||
|
This whole indented block
|
||||||
|
is a comment.
|
||||||
|
|
||||||
|
Still in the comment.
|
||||||
|
|
||||||
|
|
||||||
Source encoding
|
Source encoding
|
||||||
|
|||||||
Reference in New Issue
Block a user