Skip to content

Commit

Permalink
docs: fix README.md (#33142)
Browse files Browse the repository at this point in the history
* md

* Update README.md

* rename

* exclude

* Update README.md
  • Loading branch information
maxime-desroches authored Jul 30, 2024
1 parent 9536dd0 commit 086dcfe
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
20 changes: 12 additions & 8 deletions docs/README → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@
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
## Development
NOTE: Those commands must be run in the root directory of openpilot, **not /docs**

**1. Install the docs dependencies**
``` bash
pip install .[docs]
```

cd docs/
**2. Build the new site**
``` bash
mkdocs build
```

# for a development server
**3. Run the new site locally**
``` bash
mkdocs serve

# build the site
mkdocs build
```

References:
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ site_name: openpilot docs
repo_url: https://github.com/commaai/openpilot/
site_url: https://docs.comma.ai

exclude_docs: README.md

strict: true
docs_dir: docs
site_dir: docs_site/
Expand Down

0 comments on commit 086dcfe

Please sign in to comment.