openpilot_comma/docs/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:

• https://www.mkdocs.org/getting-started/
• https://github.com/ntno/mkdocs-terminal