mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-02-19 22:53:55 +08:00
4fbac089f8
* docs: fix nested structure * test ci * that too * update that * not common mark anymore
23 lines
428 B
Plaintext
23 lines
428 B
Plaintext
# 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
|