Skip to content

make docs.comma.ai look nicer #23260

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
merged 5 commits into from
Dec 29, 2021
Merged

make docs.comma.ai look nicer #23260

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3a14dc0
update conf:
tecandrew Dec 17, 2021
d3f0bf6
proper version extract
tecandrew Dec 17, 2021
c5b76b6
v
tecandrew Dec 21, 2021
3c146cd
Update docs/conf.py
pd0wm Dec 28, 2021
3ec78c0
Merge branch 'master' into docs-pretty
pd0wm Dec 28, 2021
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
Binary file added docs/_static/favicon.ico
View file
Open in desktop
Binary file not shown.
Binary file added docs/_static/logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 15 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@
import sys
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('..'))

OPENPILOT_ROOT = os.path.abspath('../../') # from openpilot/build/docs
VERSION = open(os.path.join(OPENPILOT_ROOT, 'selfdrive/common/version.h')).read().split()[2].strip('"')


# -- Project information -----------------------------------------------------

project = 'openpilot'
project = 'openpilot docs'
copyright = '2021, comma.ai'
author = 'comma.ai'

version = VERSION
release = VERSION

# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -54,8 +56,18 @@
# 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',
}