Revert "Add option to use og:description as description (#71)" (#73)

This reverts commit 0dc991c.
wpilibsuite · Oct 21, 2022 · be9a41d · be9a41d
1 parent 0dc991c
commit be9a41d
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 30 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -44,8 +44,6 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
-# Generate <meta name="description" content="..."> tags.
-enable_meta_description = True
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/sphinxext/opengraph/__init__.py b/sphinxext/opengraph/__init__.py
@@ -28,10 +28,10 @@
 }
 
 
-def make_tag(property: str, content: str, type_: str = "property") -> str:
+def make_tag(property: str, content: str) -> str:
     # Parse quotation, so they won't break html tags if smart quotes are disabled
     content = content.replace('"', "&quot;")
-    return f'<meta {type_}="{property}" content="{content}" />\n  '
+    return f'<meta property="{property}" content="{content}" />\n  '
 
 
 def get_tags(
@@ -104,10 +104,6 @@ def get_tags(
     # description tag
     if description:
         tags["og:description"] = description
-        if config["enable_meta_description"]:
-            config["ogp_custom_meta_tags"].append(
-                make_tag("description", description, "name")
-            )
 
     # image tag
     # Get basic values from config
@@ -187,7 +183,6 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     app.add_config_value("ogp_type", "website", "html")
     app.add_config_value("ogp_site_name", None, "html")
     app.add_config_value("ogp_custom_meta_tags", [], "html")
-    app.add_config_value("enable_meta_description", False, "html")
 
     app.connect("html-page-context", html_page_context)
 

diff --git a/tests/roots/test-meta-name-description/conf.py b/tests/roots/test-meta-name-description/conf.py
diff --git a/tests/roots/test-meta-name-description/index.rst b/tests/roots/test-meta-name-description/index.rst
diff --git a/tests/test_options.py b/tests/test_options.py
@@ -1,6 +1,7 @@
 import pytest
 from sphinx.application import Sphinx
 import conftest
+import os
 
 
 def get_tag(tags, tag_type):
@@ -25,16 +26,6 @@ def test_simple(og_meta_tags):
     )
 
 
-@pytest.mark.sphinx("html", testroot="meta-name-description")
-def test_meta_name_description(meta_tags):
-    og_description = get_tag_content(meta_tags, "description")
-    description = [tag for tag in meta_tags if tag.get("name") == "description"][0].get(
-        "content", ""
-    )
-
-    assert og_description == 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