Skip comments in dom tree traversal (#9)

Author: TheTripleV

sphinxext/opengraph.py

@@ -66,6 +66,10 @@ def dispatch_visit(self, node: nodes.Element) -> None:
         if self.stop:
             raise nodes.StopTraversal
 
+        # Skip comments
+        if isinstance(node, nodes.Invisible):
+            raise nodes.SkipNode
+
         # Skip all admonitions
         if isinstance(node, nodes.Admonition):
             raise nodes.SkipNode

tests/roots/test-skip-comments/conf.py

@@ -0,0 +1,8 @@
+extensions = ["sphinxext.opengraph"]
+
+master_doc = "index"
+exclude_patterns = ["_build"]
+
+html_theme = "basic"
+
+ogp_site_url = "http://example.org/"

tests/roots/test-skip-comments/index.rst

@@ -0,0 +1,4 @@
+.. This is a comment.
+   This is still a comment.
+
+This is text.

tests/test_options.py

@@ -80,3 +80,9 @@ def test_list_punctuation(og_meta_tags):
 def test_nested_list_punctuation(og_meta_tags):
     description = get_tag_content(og_meta_tags, "description")
     assert description == "Item 1, Item 2- Nested Item 1, Nested Item 2., Item 3, Item 4."
+
+
+@pytest.mark.sphinx("html", testroot="skip-comments")
+def test_skip_comments(og_meta_tags):
+    assert get_tag_content(og_meta_tags, "description") == "This is text."
+