2b873af75e
* push new docs * drop the new, just docs * cleanup old-commit-hash: 241fb902af49ca43bf343c60f7f96b85128a9db9
23 lines
428 B
Markdown
23 lines
428 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
|
|
```
|
|
# 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
|