How to comment a string in restructured text?
-
24-10-2019 - |
Question
The comment of HTML is <!-- .. -->
, how can I make this comment block with restructured text? In order words, how can I comment out some of the lines in restructured text?
Solution
Check: http://docutils.sourceforge.net/docs/user/rst/quickref.html#comments
Any text which begins with an explicit markup start but doesn't use the syntax of any of the constructs above, is a comment.
OTHER TIPS
Arbitrary indented text may follow the explicit markup start and will be processed as a comment element.
.. This is a comment
..
_so: is this!
..
[and] this!
..
this:: too!
..
|even| this:: !
For comments, add 2 periods ..
followed by a newline and then your comment indented.
Example:
..
comment goes here
Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow