File tree Expand file tree Collapse file tree 2 files changed +14
-8
lines changed
Expand file tree Collapse file tree 2 files changed +14
-8
lines changed Original file line number Diff line number Diff line change 33This is the source for [ docs.comma.ai] ( https://docs.comma.ai ) .
44The site is updated on pushes to master by this [ workflow] ( ../.github/workflows/docs.yaml ) .
55
6- ## development
7- ```
8- # install the docs dependencies
6+ ## Development
7+ NOTE: Those commands must be run in the root directory of openpilot, ** not /docs**
8+
9+ ** 1. Install the docs dependencies**
10+ ``` bash
911pip install .[docs]
12+ ```
1013
11- cd docs/
14+ ** 2. Build the new site**
15+ ``` bash
16+ mkdocs build
17+ ```
1218
13- # for a development server
19+ ** 3. Run the new site locally**
20+ ``` bash
1421mkdocs serve
15-
16- # build the site
17- mkdocs build
1822```
1923
2024References:
Original file line number Diff line number Diff line change @@ -2,6 +2,8 @@ site_name: openpilot docs
22repo_url : https://github.com/commaai/openpilot/
33site_url : https://docs.comma.ai
44
5+ exclude_docs : README.md
6+
57strict : true
68docs_dir : docs
79site_dir : docs_site/
You can’t perform that action at this time.
0 commit comments