mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-02-19 05:24:06 +08:00
b03f4f9b48
* md
* Update README.md
* rename
* exclude
* Update README.md
old-commit-hash: 086dcfe715
27 lines
552 B
Markdown
27 lines
552 B
Markdown
# openpilot docs
|
|
|
|
This is the source for [docs.comma.ai](https://docs.comma.ai).
|
|
The site is updated on pushes to master by this [workflow](../.github/workflows/docs.yaml).
|
|
|
|
## Development
|
|
NOTE: Those commands must be run in the root directory of openpilot, **not /docs**
|
|
|
|
**1. Install the docs dependencies**
|
|
``` bash
|
|
pip install .[docs]
|
|
```
|
|
|
|
**2. Build the new site**
|
|
``` bash
|
|
mkdocs build
|
|
```
|
|
|
|
**3. Run the new site locally**
|
|
``` bash
|
|
mkdocs serve
|
|
```
|
|
|
|
References:
|
|
* https://www.mkdocs.org/getting-started/
|
|
* https://github.com/ntno/mkdocs-terminal
|