sunnypilot/docs
Jason Wen d35cdb510d
Sync: `commaai/msgq:master` into `sunnypilot/msgq:master`
Sync: `commaai/opendbc:master` into `sunnypilot/opendbc:master`

Sync: `commaai/panda:master` into `sunnypilot/panda:master`
2024-08-03 21:22:09 -04:00
..
assets Revert "docs: fix car docs video icon" (#31234) 2024-01-30 19:04:43 -08:00
car-porting docs: fix nested structure (#33114) 2024-07-28 15:38:38 -07:00
concepts docs: add concepts section 2024-07-28 16:38:41 -07:00
contributing docs: fix nested structure (#33114) 2024-07-28 15:38:38 -07:00
getting-started docs: fix nested structure (#33114) 2024-07-28 15:38:38 -07:00
how-to docs: add concepts section 2024-07-28 16:38:41 -07:00
BOUNTIES.md Update BOUNTIES.md re. Toyota SecOC and community bounty. (#32661) 2024-06-08 16:10:58 -07:00
CARS.md Chrysler Pacifica Hybrid: combine 2017 and 2018 (#32937) 2024-07-08 14:45:01 -07:00
CONTRIBUTING.md typo (#31618) 2024-02-27 11:55:19 -08:00
HOW-TOS.md Update HOW-TOS.md 2023-11-26 18:01:55 -05:00
INTEGRATION.md One-word grammar fix to docs/INTEGRATION.md (#26621) 2022-11-29 00:38:18 -08:00
LIMITATIONS.md Sphinx docs generation (#22697) 2021-10-28 15:14:37 +02:00
README.md docs: fix README.md (#33142) 2024-07-30 13:57:42 -07:00
SAFETY.md Update SAFETY.md (#29129) 2023-07-24 21:13:40 -07:00
WORKFLOW.md remove pre-commit (explorations) (#33172) 2024-08-01 22:16:13 -07:00
index.md docs: fix nested structure (#33114) 2024-07-28 15:38:38 -07:00
sunnyhaibin0850_qrcode_paypal.me.png LFS: Move to sunnypilot's public GitLab 2024-04-11 15:41:59 +00:00

README.md

openpilot docs

This is the source for docs.comma.ai. The site is updated on pushes to master by this workflow.

Development

NOTE: Those commands must be run in the root directory of openpilot, not /docs

1. Install the docs dependencies

pip install .[docs]

2. Build the new site

mkdocs build

3. Run the new site locally

mkdocs serve

References: