You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27 lines
552 B
27 lines
552 B
6 days ago
|
# 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
|