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
This commit is contained in:
Andrew
2021-12-28 09:07:32 -08:00
committed by GitHub
parent 86a39e838b
commit 06c80e264c
5 changed files with 37 additions and 4 deletions

BIN
Pipfile LFS

Binary file not shown.

BIN
Pipfile.lock LFS generated

Binary file not shown.

BIN
docs/_static/logo.png LFS vendored Normal file

Binary file not shown.

2
docs/_static/robots.txt vendored Normal file
View File

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

View File

@@ -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']