Skip to content

Add meta tags to API docs #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crandmck merged 1 commit into from
Apr 17, 2026
+23 −0
Merged

Add meta tags to API docs #251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions api-docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,27 @@
napoleon_google_docstring = True
napoleon_numpy_docstring = False

# -- Global HTML meta tags ---------------------------------------------------

# Inject extra <meta> tags into the <head> of every generated HTML page,
# regardless of source format (.rst, .md, AutoAPI-generated, etc.).
html_meta_tags = [
{"name": "algolia-site-verification", "content": "EA363696C40197CA"},
]


def _add_html_meta_tags(app, pagename, templatename, context, doctree):
rendered = "".join(
"<meta "
+ " ".join(f'{k}="{v}"' for k, v in tag.items())
+ " />\n"
for tag in html_meta_tags
)
context["metatags"] = context.get("metatags", "") + rendered


def setup(app):
app.connect("html-page-context", _add_html_meta_tags)
return {"parallel_read_safe": True, "parallel_write_safe": True}


Loading