docs.comma.ai add sitemap and robots.txt (#23259)

* add sitemap generator

* update conf for seo

* remove cmake var

* relock

* fix html_baseurl

* more fixes

* newline

Co-authored-by: Willem Melching <willem.melching@gmail.com>
old-commit-hash: c95202bd1c1882f30dbb153d58de4d875cdbf025

Pipfile

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:46258ab149de8606b809e271264382d5450c11e914bb72c37697345290bd39f1
-size 1215
+oid sha256:5f2b0d547ef23a2ca1279e516813c82d4dc1a6b258d5e1356bfbe59211459068
+size 1236

Pipfile.lock

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:871bf11488728e41699192b10314fde73cd8ca57acc803d452de76ac756bf3af
-size 144757
+oid sha256:2e3700d16d52db5ed0b47e55dee17c900f0b9bbfd8cf865e911f00d7a6d85403
+size 146742

docs/_static/logo.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:42bc589954cad7f16cef694887dee2c819378f7dacfdddea2ff833ff65a109fd
+size 1122

docs/_static/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Sitemap: https://docs.comma.ai/sitemap.xml

docs/conf.py

@@ -25,6 +25,7 @@ sys.path.insert(0, os.path.abspath('..'))
 project = 'openpilot'
 copyright = '2021, comma.ai'
 author = 'comma.ai'
+language = 'en'
 
 
 # -- General configuration ---------------------------------------------------
@@ -37,8 +38,34 @@ extensions = [
         'sphinx.ext.viewcode',  # Add view code link to modules
         'sphinx_rtd_theme',     # Read The Docs theme
         'myst_parser',          # Markdown parsing
+        'sphinx_sitemap',       # sitemap generation for SEO
 ]
 
+myst_html_meta = {
+   "description": "openpilot docs",
+   "keywords": "op, openpilot, docs, documentation",
+   "robots": "all,follow",
+   "googlebot": "index,follow,snippet,archive",
+   "property=og:locale": "en_US",
+   "property=og:site_name": "docs.comma.ai",
+   "property=og:url": "https://docs.comma.ai",
+   "property=og:title": "openpilot Docuemntation",
+   "property=og:type": "website",
+   "property=og:image:type": "image/jpeg",
+   "property=og:image:width": "400",
+   "property=og:image": "https://docs.comma.ai/_static/logo.png",
+   "property=og:image:url": "https://docs.comma.ai/_static/logo.png",
+   "property=og:image:secure_url": "https://docs.comma.ai/_static/logo.png",
+   "property=og:description": "openpilot Documentation",
+   "property=twitter:card": "summary_large_image",
+   "property=twitter:logo": "https://docs.comma.ai/_static/logo.png",
+   "property=twitter:title": "openpilot Documentation",
+   "property=twitter:description": "openpilot Documentation"
+}
+
+html_baseurl = 'https://docs.comma.ai/'
+sitemap_filename = "sitemap.xml"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -59,3 +86,4 @@ html_theme = 'sphinx_rtd_theme'
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+html_extra_path = ['_static']