Don't overwrite a page's existing manual meta og:description tag

wpilibsuite · Oct 22, 2022 · 161f2b5 · 161f2b5
1 parent de9eccc
commit 161f2b5
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 3 deletions.
diff --git a/sphinxext/opengraph/__init__.py b/sphinxext/opengraph/__init__.py
@@ -32,7 +32,7 @@
 def make_tag(property: str, content: str, type_: str = "property") -> str:
     # Parse quotation, so they won't break html tags if smart quotes are disabled
     content = content.replace('"', "&quot;")
-    return f'<meta property="{property}" content="{content}" />'
+    return f'<meta {type_}="{property}" content="{content}" />'
 
 
 def get_tags(

diff --git a/...me-description-no-override-manual/conf.py → ...me-description-manual-description/conf.py b/...me-description-no-override-manual/conf.py → ...me-description-manual-description/conf.py
diff --git a/...-description-no-override-manual/index.rst → ...-description-manual-description/index.rst b/...-description-no-override-manual/index.rst → ...-description-manual-description/index.rst
diff --git a/tests/roots/test-meta-name-description-manual-og-description/conf.py b/tests/roots/test-meta-name-description-manual-og-description/conf.py
@@ -0,0 +1,10 @@
+extensions = ["sphinxext.opengraph"]
+
+master_doc = "index"
+exclude_patterns = ["_build"]
+
+html_theme = "basic"
+
+ogp_site_url = "http://example.org/en/latest/"
+
+ogp_enable_meta_description = True
diff --git a/tests/roots/test-meta-name-description-manual-og-description/index.rst b/tests/roots/test-meta-name-description-manual-og-description/index.rst
@@ -0,0 +1,3 @@
+:og:description: My manual og:description
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse at lorem ornare, fringilla massa nec, venenatis mi. Donec erat sapien, tincidunt nec rhoncus nec, scelerisque id diam. Orci varius natoque penatibus et magnis dis parturient mauris.
diff --git a/tests/test_options.py b/tests/test_options.py
@@ -1,7 +1,6 @@
 import pytest
 from sphinx.application import Sphinx
 import conftest
-import os
 
 
 def get_tag(tags, tag_type):
@@ -40,7 +39,7 @@ def test_meta_name_description(meta_tags):
     assert description == og_description
 
 
-@pytest.mark.sphinx("html", testroot="meta-name-description-no-override-manual")
+@pytest.mark.sphinx("html", testroot="meta-name-description-manual-description")
 def test_meta_name_description(meta_tags):
     og_description = get_tag_content(meta_tags, "description")
     description = get_meta_description(meta_tags)
@@ -49,6 +48,15 @@ def test_meta_name_description(meta_tags):
     assert description == "My manual description"
 
 
+@pytest.mark.sphinx("html", testroot="meta-name-description-manual-og-description")
+def test_meta_name_description(meta_tags):
+    og_description = get_tag_content(meta_tags, "description")
+    description = get_meta_description(meta_tags)
+
+    assert og_description != description
+    assert og_description == "My manual og:description"
+
+
 @pytest.mark.sphinx("html", testroot="simple")
 def test_site_url(og_meta_tags):
     # Uses the same directory as simple, because it already contains url for a minimal config