docs: add Google Analytics and a sitemap

[shenxianpeng]

These docs are served from the cpp-linter.github.io origin, but unlike the organization site they have no Google Analytics. So there is no record of what readers look at once they leave the organization's home page. These were also the only cpp-linter docs without a sitemap. This PR adds the same property the organization site uses (G-JKH4SXC7HC). It also adds the maintainer flag from cpp-linter/cpp-linter.github.io#83, so the maintainers' own reading can be filtered out.

This PR only changes the site. The Google Analytics side (the Internal Traffic filter, key events) is handled separately.

Before / After (改动前 / 改动后)

	Before (live site, origin/main)	After (this branch, sphinx-build docs)
Google Analytics	No gtag on any page	G-JKH4SXC7HC on every page (sphinx-immaterial's analytics theme option)
Maintainer visits	—	traffic_type=internal while the cpp-linter-internal flag is set (?internal=1 / ?internal=0 on any page of the origin), via docs/_templates/layout.html
sitemap.xml	404	18 URLs: all pages and API reference pages. search.html, genindex.html, py-modindex.html and _modules/* are excluded.
Docs dependencies	sphinx-immaterial	+ sphinx-sitemap>=2.9.0 (lock updated with uv 0.13.1; the diff only adds sphinx-sitemap and its dependency sphinx-last-updated-by-git)

Evidence: built <head> of index.html

<script>
  try {
    var param = new URLSearchParams(location.search).get("internal");
    if (param === "1") localStorage.setItem("cpp-linter-internal", "1");
    if (param === "0") localStorage.removeItem("cpp-linter-internal");
    if (localStorage.getItem("cpp-linter-internal") === "1") {
      window.dataLayer = window.dataLayer || [];
      (function () { dataLayer.push(arguments); })("set", { traffic_type: "internal" });
    }
  } catch (e) {
    // localStorage is unavailable when storage is blocked; the visit is then not tagged.
  }
</script>
<script id="__analytics">function __md_analytics(){ /* … the theme's snippet, unchanged … */ var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-JKH4SXC7HC",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>

The flag script comes before id="__analytics" (character 1160 vs 1554 in the built index.html).

Evidence: sitemap.xml

https://cpp-linter.github.io/cpp-linter/API-Reference/cpp_linter.html
https://cpp-linter.github.io/cpp-linter/API-Reference/cpp_linter.clang_tools.html
… (12 API reference pages in total)
https://cpp-linter.github.io/cpp-linter/building_docs.html
https://cpp-linter.github.io/cpp-linter/cli_args.html
https://cpp-linter.github.io/cpp-linter/contributing.html
https://cpp-linter.github.io/cpp-linter/index.html
https://cpp-linter.github.io/cpp-linter/permissions.html
https://cpp-linter.github.io/cpp-linter/pr_review_caveats.html

The organization site's robots.txt (cpp-linter/cpp-linter.github.io#83) lists https://cpp-linter.github.io/cpp-linter/sitemap.xml.

Notes

• The flag snippet runs in the theme's analytics block, before the theme's own snippet. That way gtag('set', {traffic_type: 'internal'}) is queued ahead of the first page_view. The same snippet was tested end to end with the real gtag.js and a fake measurement ID in feat: tag maintainer visits, track code copies and add social cards cpp-linter.github.io#83: tt=internal is sent after ?internal=1 and stops after ?internal=0.
• None of these changes alters a page's layout, so there are no screenshots.
• cspell.config.yml gains genindex and modindex (Sphinx page names in sitemap_excludes).

Summary by CodeRabbit

• New Features
  • Documentation pages are now included in a sitemap, making them easier for search engines to discover.
  • Documentation analytics now distinguish visits marked as internal, helping separate them from other traffic.
• Chores
  • Added documentation-related terms to spelling checks.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: fdad53c2-6265-47ee-91c7-8b542bf9bbf9

📥 Commits

Reviewing files that changed from the base of the PR and between ce85d58 and 586cc57.

⛔ Files ignored due to path filters: 1

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing: 4

• cspell.config.yml
• docs/_templates/layout.html
• docs/conf.py
• pyproject.toml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The documentation build now generates a sitemap with configured URL and exclusion settings, and configures Google Analytics. The layout template uses the internal query parameter to set an internal-traffic flag and tag analytics traffic. The spelling list includes genindex and modindex.

Changes

Documentation sitemap

Layer / File(s)	Summary
Sitemap configuration pyproject.toml, docs/conf.py, cspell.config.yml	The docs dependencies and Sphinx configuration add sitemap generation, set URL settings, and exclude selected pages. The spelling list adds genindex and modindex.

Documentation analytics

Layer / File(s)	Summary
Analytics configuration and internal traffic flag docs/conf.py, docs/_templates/layout.html	The theme configures a Google Analytics property. The layout template updates a local-storage flag based on the internal query parameter and queues traffic_type=internal when the flag is stored. Errors in the setup are caught, and the parent analytics block is still rendered.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 586cc

The documentation site adds sitemap generation and Google Analytics tracking, including internal-visit tagging. No actionable merge-blocking regression is established.

Pre-merge checks: 5

Check name	Status	Explanation
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the two primary changes: adding Google Analytics and a sitemap to the documentation site.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ce85d58) to head (586cc57).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #237   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           26        26           
  Lines         2008      2008           
=========================================
  Hits          2008      2008           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.