docs/index.md

# 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
```
Sphinx docs generation (#22697) * add sphinx * switch theme * Experiment: sphinx docs generation updated (#22708) * moved build to root gitignore, added .gitkeep * Improved makefile doc build process - Removed auto-generated docs from source control - Moved apidoc.sh into Makefile - Removed make.bat (can add back if Windows support desired) - Added sphinx viewcode and markdown extensions - Added feature to source /docs in build, so any .rst file in /docs will override the respective file during the build process - Added feature to copy all markdown/rst files from source into /build/ during build process so they can be easily referenced while writing docs (see examples in index.md) - Wrote basic starter index.md file TODO: Add new dependencies to Pipfile [dev-packages] * Revert accidental modification to Pipfile * fix command substitution * exclude xx * improve docs * dont include all docs in release build * Add dockerfile * update title * include normal readme * build container in CI * use buildkit * add login Co-authored-by: Chad Bailey <chadbailey904@gmail.com> 2021-10-28 15:14:37 +02:00			`# 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}
docs: setup docs for C code (#23262) * 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> 2022-01-04 08:26:07 -08:00			`:caption: 'Python API'`
Sphinx docs generation (#22697) * add sphinx * switch theme * Experiment: sphinx docs generation updated (#22708) * moved build to root gitignore, added .gitkeep * Improved makefile doc build process - Removed auto-generated docs from source control - Moved apidoc.sh into Makefile - Removed make.bat (can add back if Windows support desired) - Added sphinx viewcode and markdown extensions - Added feature to source /docs in build, so any .rst file in /docs will override the respective file during the build process - Added feature to copy all markdown/rst files from source into /build/ during build process so they can be easily referenced while writing docs (see examples in index.md) - Wrote basic starter index.md file TODO: Add new dependencies to Pipfile [dev-packages] * Revert accidental modification to Pipfile * fix command substitution * exclude xx * improve docs * dont include all docs in release build * Add dockerfile * update title * include normal readme * build container in CI * use buildkit * add login Co-authored-by: Chad Bailey <chadbailey904@gmail.com> 2021-10-28 15:14:37 +02:00			`:maxdepth: 2`

			`modules.rst`
			```
docs: setup docs for C code (#23262) * 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> 2022-01-04 08:26:07 -08:00
			```{toctree}
			`:caption: 'C/C++ API'`
			`:maxdepth: 4`

			`c_docs.rst`
			```