mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-02-19 03:03:57 +08:00
* add breathe and doxygen
* add sphinx-breathe c docs generation
* add c docs to site
* built in docker
* build base image first
* namespace cleanup
* Revert "build base image first"
This reverts commit 4c44c02ffb93b3f0bc3968f2ee1fdc64faa25608.
* its in the dockerfile
Co-authored-by: Willem Melching <willem.melching@gmail.com>
old-commit-hash: 9f70bea964
42 lines
442 B
Markdown
42 lines
442 B
Markdown
# openpilot Documentation
|
|
|
|
```{include} README.md
|
|
```
|
|
|
|
```{toctree}
|
|
:caption: 'General'
|
|
:maxdepth: 4
|
|
|
|
CARS.md
|
|
CONTRIBUTING.md
|
|
INTEGRATION.md
|
|
LIMITATIONS.md
|
|
SAFETY.md
|
|
```
|
|
|
|
```{toctree}
|
|
:caption: 'Overview'
|
|
:maxdepth: 2
|
|
|
|
overview.rst
|
|
```
|
|
|
|
## API Documentation
|
|
|
|
- {ref}`genindex`
|
|
- {ref}`modindex`
|
|
- {ref}`search`
|
|
|
|
```{toctree}
|
|
:caption: 'Python API'
|
|
:maxdepth: 2
|
|
|
|
modules.rst
|
|
```
|
|
|
|
```{toctree}
|
|
:caption: 'C/C++ API'
|
|
:maxdepth: 4
|
|
|
|
c_docs.rst
|
|
``` |