Skip when building embedded HTML

sphinxext/opengraph/__init__.py

@@ -60,7 +60,7 @@ def html_page_context(
     context: dict[str, Any],
     doctree: nodes.document,
 ) -> None:
-    if doctree:
+    if doctree and not app.builder.embedded:
         context['metatags'] += get_tags(
             context,
             doctree,

tests/conftest.py

@@ -32,11 +32,11 @@ def content(app):
     return app
 
 
-def _meta_tags(content, subdir=None):
+def _meta_tags(content, subdir=None, target='index.html'):
     if subdir is None:
-        c = (content.outdir / 'index.html').read_text(encoding='utf-8')
+        c = (content.outdir / target).read_text(encoding='utf-8')
     else:
-        c = (content.outdir / subdir / 'index.html').read_text(encoding='utf-8')
+        c = (content.outdir / subdir / target).read_text(encoding='utf-8')
     return BeautifulSoup(c, 'html.parser').find_all('meta')
 
 
@@ -53,9 +53,7 @@ def meta_tags(content):
 
 @pytest.fixture
 def og_meta_tags(content):
-    return [
-        tag for tag in _meta_tags(content) if tag.get('property', '').startswith('og:')
-    ]
+    return _og_meta_tags(content)
 
 
 @pytest.fixture

tests/roots/test-simple/conf.py

@@ -8,3 +8,7 @@
 html_theme = 'basic'
 
 ogp_site_url = 'http://example.org/en/latest/'
+
+# needed for ePub build
+epub_copyright = 'sphinxext.opengraph team'
+version = '1.0'

tests/test_options.py

@@ -42,6 +42,16 @@ def test_simple(og_meta_tags):
     )
 
 
+@pytest.mark.sphinx('epub', testroot='simple')
+def test_epub(content: Sphinx):
+    """Ogp tags are disabled for ePub build"""
+    meta_tags = conftest._meta_tags(content, target='index.xhtml')
+    og_meta_tags = [
+        tag for tag in meta_tags if tag.get('property', '').startswith('og:')
+    ]
+    assert len(og_meta_tags) == 0
+
+
 @pytest.mark.sphinx('html', testroot='meta-name-description')
 def test_meta_name_description(meta_tags):
     og_description = get_tag_content(meta_tags, 'description')