Skip to content

docs: 🔍 Verify the book in Google Search Console #218

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
ShisatoYano merged 1 commit into from
Nov 8, 2026
Merged

docs: 🔍 Verify the book in Google Search Console #218

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
14 changes: 9 additions & 5 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"main/src/simulations/mapping/ndt_map_construction/ndt_map_construction.gif")
ogp_image_alt = "A vehicle building a map from LiDAR points in the simulation"
ogp_social_cards = {"enable": False}
GOOGLE_SITE_VERIFICATION = "-jqdmEvaEhWDv2hYifGImJuaC1xrupOK6EFNfzg7h9w"
# Shows the "Edit on GitHub" link at the top of each page
html_context = {
"display_github": True,
Expand Down Expand Up @@ -144,11 +145,14 @@ def add_section_toctree(app: Sphinx, docname: str, source: list[str]) -> None:
source[0] = title + "\n\n" + toctree + body


def drop_front_page_title_suffix(app: Sphinx, pagename: str, templatename: str,
context: dict, doctree) -> None:
def set_front_page_context(app: Sphinx, pagename: str, templatename: str,
context: dict, doctree) -> None:
if pagename != app.config.root_doc:
return
# The front page's heading is the book's title, so "<title> — <html_title>" would repeat it
if pagename == app.config.root_doc:
context["docstitle"] = None
context["docstitle"] = None
# Proves to Google Search Console that the maintainer owns the site; removing it unverifies it
context["metatags"] += f'\n<meta name="google-site-verification" content="{GOOGLE_SITE_VERIFICATION}" />'


def draw_figures(app: Sphinx) -> None:
Expand Down Expand Up @@ -176,4 +180,4 @@ def setup(app: Sphinx) -> None:
app.connect("builder-inited", draw_figures)
app.connect("source-read", rewrite_links)
app.connect("source-read", add_section_toctree)
app.connect("html-page-context", drop_front_page_title_suffix)
app.connect("html-page-context", set_front_page_context)
Loading