mirror of https://github.com/1okko/openpilot.git
docs: fix README.md (#33142)
* md * Update README.md * rename * exclude * Update README.md
This commit is contained in:
parent
9536dd07c6
commit
086dcfe715
|
@ -3,20 +3,24 @@
|
||||||
This is the source for [docs.comma.ai](https://docs.comma.ai).
|
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).
|
The site is updated on pushes to master by this [workflow](../.github/workflows/docs.yaml).
|
||||||
|
|
||||||
## development
|
## Development
|
||||||
```
|
NOTE: Those commands must be run in the root directory of openpilot, **not /docs**
|
||||||
# install the docs dependencies
|
|
||||||
|
**1. Install the docs dependencies**
|
||||||
|
``` bash
|
||||||
pip install .[docs]
|
pip install .[docs]
|
||||||
|
```
|
||||||
|
|
||||||
cd docs/
|
**2. Build the new site**
|
||||||
|
``` bash
|
||||||
# for a development server
|
|
||||||
mkdocs serve
|
|
||||||
|
|
||||||
# build the site
|
|
||||||
mkdocs build
|
mkdocs build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**3. Run the new site locally**
|
||||||
|
``` bash
|
||||||
|
mkdocs serve
|
||||||
|
```
|
||||||
|
|
||||||
References:
|
References:
|
||||||
* https://www.mkdocs.org/getting-started/
|
* https://www.mkdocs.org/getting-started/
|
||||||
* https://github.com/ntno/mkdocs-terminal
|
* https://github.com/ntno/mkdocs-terminal
|
|
@ -2,6 +2,8 @@ site_name: openpilot docs
|
||||||
repo_url: https://github.com/commaai/openpilot/
|
repo_url: https://github.com/commaai/openpilot/
|
||||||
site_url: https://docs.comma.ai
|
site_url: https://docs.comma.ai
|
||||||
|
|
||||||
|
exclude_docs: README.md
|
||||||
|
|
||||||
strict: true
|
strict: true
|
||||||
docs_dir: docs
|
docs_dir: docs
|
||||||
site_dir: docs_site/
|
site_dir: docs_site/
|
||||||
|
|
Loading…
Reference in New Issue