From 94f0ec19d04522d22b2f55a9bcf0740894a5ada0 Mon Sep 17 00:00:00 2001 From: Andrew Date: Wed, 29 Dec 2021 08:31:56 -0800 Subject: [PATCH] add version to docs.comma.ai (#23260) * update conf: * add logo and favicon from connect.comma.ai * add version * proper version extract * v * Update docs/conf.py Co-authored-by: Willem Melching old-commit-hash: c86ca387c2fd98366057a146735ef2b388f4d070 --- docs/_static/favicon.ico | 3 +++ docs/conf.py | 16 ++++++++++++++-- 2 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 docs/_static/favicon.ico diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000..5bd2e6cebb --- /dev/null +++ b/docs/_static/favicon.ico @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d2802090da910c4ca103d8ef664f5bdc671e6035890ec7c41c1c6b9a5675294e +size 15086 diff --git a/docs/conf.py b/docs/conf.py index ab384369df..dfab59988f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,16 +15,19 @@ # import os import sys +from selfdrive.version import get_version sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..')) - +VERSION = get_version() # -- Project information ----------------------------------------------------- -project = 'openpilot' +project = 'openpilot docs' copyright = '2021, comma.ai' author = 'comma.ai' +version = VERSION +release = VERSION language = 'en' @@ -81,9 +84,18 @@ exclude_patterns = [] # a list of builtin themes. # html_theme = 'sphinx_rtd_theme' +html_show_copyright = True # Add any paths that contain custom static files (such as style sheets) here, # 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_logo = '_static/logo.png' +html_favicon = '_static/favicon.ico' +html_theme_options = { + 'logo_only': False, + 'display_version': True, + 'vcs_pageview_mode': 'blob', + 'style_nav_header_background': '#000000', +} html_extra_path = ['_static']