Exclude raw nodes from description (#23)

Author: TheTripleV

sphinxext/opengraph.py

@@ -97,6 +97,9 @@ def dispatch_visit(self, node: nodes.Element) -> None:
             if node.astext() in self.known_titles:
                 raise nodes.SkipNode
 
+        if isinstance(node, nodes.raw):
+            raise nodes.SkipNode
+
         # Only include leaf nodes in the description
         if len(node.children) == 0:
             text = node.astext().replace("\r", "").replace("\n", " ").strip()

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

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

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

@@ -0,0 +1,7 @@
+This text should be included.
+
+.. raw:: html
+
+    <p> This text should be skipped. </p>
+
+This text should also be included.

tests/test_options.py

@@ -100,3 +100,13 @@ def test_skip_comments(og_meta_tags):
 @pytest.mark.sphinx("html", testroot="custom-tags")
 def test_custom_tags(og_meta_tags):
     assert get_tag_content(og_meta_tags, "ignore_canonical") == "true"
+
+
+@pytest.mark.sphinx("html", testroot="skip-raw")
+def test_skip_raw(og_meta_tags):
+    description = get_tag_content(og_meta_tags, "description")
+    assert "<p>" not in description
+    assert (
+        description
+        == "This text should be included. This text should also be included."
+    )