From fc8bf86599673dff7a7d5ce59f0c2fbcf804cf89 Mon Sep 17 00:00:00 2001 From: Jason Wen Date: Sun, 4 Aug 2024 14:33:44 -0400 Subject: [PATCH] init --- .gitignore | 1 + mkdocs-sp.yml | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 4 ++++ 3 files changed, 60 insertions(+) create mode 100644 mkdocs-sp.yml diff --git a/.gitignore b/.gitignore index 1dfb3f3514..d6300e3dbd 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ a.out .hypothesis /docs_site/ +/docs_sp_site/ *.dylib *.DSYM diff --git a/mkdocs-sp.yml b/mkdocs-sp.yml new file mode 100644 index 0000000000..a1776d71cf --- /dev/null +++ b/mkdocs-sp.yml @@ -0,0 +1,55 @@ +site_name: sunnypilot docs +repo_name: sunnypilot/sunnypilot +repo_url: https://github.com/sunnypilot/sunnypilot/ +site_description: sunnypilot Documentation +site_url: https://docs.sunnypilot.ai +edit_uri: blob/new-docs/docs_sp + +exclude_docs: README.md + +strict: true +docs_dir: docs_sp +site_dir: docs_sp_site/ + +theme: + name: material + icon: + repo: fontawesome/brands/github + edit: material/lead-pencil + view: material/eye + features: + - content.action.edit + - navigation.tabs + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to system preference + navigation_depth: 3 + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences + +nav: + - Getting Started: + - What is sunnypilot?: getting-started/what-is-sunnypilot.md + - Features: + - Modified Assistive Driving Safety (M.A.D.S.): features/modified-assistive-driving-safety.md + - how-to: + - Enable Mapbox navigation: how-to/enable-mapbox-navigation.md + - Enable Radar Tracks: how-to/radar-tracks.md diff --git a/pyproject.toml b/pyproject.toml index 90b6ecf983..33a76b0297 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -69,6 +69,10 @@ docs = [ "Jinja2", "natsort", "mkdocs", + "mkdocs-material", + "mkdocs-git-revision-date-localized-plugin", + "mkdocs-git-committers-plugin-2", + "mkdocs-git-authors-plugin", ] testing = [