htmlsanity: don't put comments into HTML as <!-- -->.

The escaping is weird for the license header because of <> and I don't
think this is of any use.

diff --git a/doc/pelican/writing-content.rst b/doc/pelican/writing-content.rst
index d16692006805fa6743fd52de0423747e9a503e18..a13f669727a4a550df0c6c57f56f1997f9fb2b64 100644 (file)
--- a/doc/pelican/writing-content.rst
+++ b/doc/pelican/writing-content.rst
@@ -95,8 +95,8 @@ Example:
 
     Another character used, another level of headings.
 
-    .. a comment which is rendered to HTML output enclosed in <!-- -->
-        characters. This is still a comment.
+    .. a comment, which is simply ignored when producing HTML output.
+        This is still a comment.
 
         This as well.
             and

diff --git a/doc/plugins/htmlsanity.rst b/doc/plugins/htmlsanity.rst
index 051ed80aff650728c9ccc46c42466554a3256d59..8ac4ed1a34bb1686996986a27b37c08684431868 100644 (file)
--- a/doc/plugins/htmlsanity.rst
+++ b/doc/plugins/htmlsanity.rst
@@ -82,6 +82,8 @@ horrible, right?) with a custom HTML5 writer derived from
 -   Line blocks are simply :html:`<p>` elements with lines delimited using
     :html:`<br>`
 -   The :html:`<abbr>` tag now properly includes a ``title`` attribute
+-   :abbr:`reST <reStructuredText>` comments are simply ignored, instead of
+    being put into :html:`<!-- -->`
 
 `Typography`_
 =============

diff --git a/pelican-plugins/m/htmlsanity.py b/pelican-plugins/m/htmlsanity.py
index 1a2c7150f109a05f1a4e5406a61660ce0d7cf984..4e55a02a168e9873fd3faca1e8db3518bb1d4d51 100644 (file)
--- a/pelican-plugins/m/htmlsanity.py
+++ b/pelican-plugins/m/htmlsanity.py
@@ -340,6 +340,11 @@ class SaneHtmlTranslator(HTMLTranslator):
             ('colwidths-given' not in node.parent.parent['classes'])):
             return
 
+    # Don't put comments into the HTML output
+    def visit_comment(self, node,
+                      sub=re.compile('-(?=-)').sub):
+        raise nodes.SkipNode
+
     # Containers don't need those stupid "docutils" class names
     def visit_container(self, node):
         atts = {}