How to comment a string in restructured text?

html restructuredtext
prosseek picture prosseek · Jan 24, 2011 · Viewed 26.4k times · Source

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?

Answer

jball picture jball · Jan 24, 2011

From the reference:

Arbitrary indented text may follow the explicit markup start and will be processed as a comment element.

..
   _This: is a comment!

..
   [and] this!

..
   this:: too!

..
   |even| this:: !

It is also possible to put the comment on the same line as the double dots:

.. Avoid this type of comment

This is however considered bad practice since it may lead to unintended consequences if the comment matches a proper markup construct, as pointed out by @CecilCurry in the comment below.

Related questions

How to use color in text with ReStructured Text (rst2html.py) or how to insert HTML tags without blank lines?

How can I use color with ReStructured Text? For example, **hello** translates into <strong>hello</strong>. How can I make ReStructure(rst2html.py) translate something into <font color="####">text</font>? I …

Read More
sphinx, restructuredtext: set color for a single word

Is there a way to set the color of single words (or characters) in sphinx? I'm pretty sure there should be some markup tag, like HTML's font tag.

Read More
How to embed HTML in restructured text file?

I'm using reStructuredText and I'd like to add HTML encoding an interactive flash-type animation through the <embed> tag. From my .rst document, how can I specify the position of this arbitrary chunk of HTML? Something like: .. html :: <…

Read More