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.
23 lines
428 B
23 lines
428 B
1 year ago
|
# openpilot docs
|
||
2 years ago
|
|
||
|
1 year ago
|
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
|
||
|
|
```
|
||
|
|
# install the docs dependencies
|
||
|
|
pip install .[docs]
|
||
|
|
|
||
|
|
cd docs/
|
||
|
|
|
||
|
|
# for a development server
|
||
|
|
mkdocs serve
|
||
|
|
|
||
|
|
# build the site
|
||
|
|
mkdocs build
|
||
|
|
```
|
||
|
|
|
||
|
|
References:
|
||
|
|
* https://www.mkdocs.org/getting-started/
|
||
|
|
* https://github.com/ntno/mkdocs-terminal
|