mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-02-19 04:13:54 +08:00
67f41f32f1
* 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>
old-commit-hash: b816b5b644
80 lines
1.1 KiB
ReStructuredText
80 lines
1.1 KiB
ReStructuredText
openpilot
|
|
=========
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
Debugging <selfdrive/debug/README.md>
|
|
selfdrive/loggerd/README.md
|
|
Driver Monitoring <selfdrive/monitoring/README.md>
|
|
Process Replay <selfdrive/test/process_replay/README.md>
|
|
|
|
cereal
|
|
=========
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
cereal/README.md
|
|
cereal/messaging/msgq.md
|
|
|
|
laika
|
|
=========
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
laika_repo/README.md
|
|
|
|
models
|
|
=========
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
models/README.md
|
|
|
|
opendbc
|
|
=========
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
opendbc/README.md
|
|
|
|
panda
|
|
=========
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
panda/README.md
|
|
panda/UPDATING.md
|
|
panda/board/README.md
|
|
panda/drivers/linux/README.md
|
|
panda/drivers/windows/README.md
|
|
|
|
|
|
rednose
|
|
=========
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
rednose_repo/README.md
|
|
|
|
|
|
tools
|
|
=========
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
|
|
tools/CTF.md
|
|
tools/joystick/README.md
|
|
tools/lib/README.md
|
|
tools/plotjuggler/README.md
|
|
tools/replay/README.md
|
|
tools/serial/README.md
|
|
Simulator <tools/sim/README.md>
|
|
tools/ssh/README.md
|
|
Webcam <tools/webcam/README.md>
|