Skip to content

Commit eec4bc9

Browse files
committed
Add meta tags to API docs
1 parent ece50bf commit eec4bc9

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

api-docs/conf.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,27 @@
6161
napoleon_google_docstring = True
6262
napoleon_numpy_docstring = False
6363

64+
# -- Global HTML meta tags ---------------------------------------------------
65+
66+
# Inject extra <meta> tags into the <head> of every generated HTML page,
67+
# regardless of source format (.rst, .md, AutoAPI-generated, etc.).
68+
html_meta_tags = [
69+
{"name": "algolia-site-verification", "content": "EA363696C40197CA"},
70+
]
71+
72+
73+
def _add_html_meta_tags(app, pagename, templatename, context, doctree):
74+
rendered = "".join(
75+
"<meta "
76+
+ " ".join(f'{k}="{v}"' for k, v in tag.items())
77+
+ " />\n"
78+
for tag in html_meta_tags
79+
)
80+
context["metatags"] = context.get("metatags", "") + rendered
81+
82+
83+
def setup(app):
84+
app.connect("html-page-context", _add_html_meta_tags)
85+
return {"parallel_read_safe": True, "parallel_write_safe": True}
86+
6487

0 commit comments

Comments
 (0)