openpilot_comma

5326 Commits

43 Branches

82 Tags

6.7 GiB

Tag: Branch: Tree: 8160cf3c1b

Commit Graph

Author	SHA1	Message	Date
Willem Melching	b816b5b644	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>	4 years ago
Jay Zuo	96c3bd85cf	Fixed broken link to supported cars (#22301 ) Now links to the proper page with ACC column	4 years ago
George Hotz	105be028bd	Update Docs (#22229 ) * initial move of docs * more cleanups * more docs * simpler * more docs * link fix * typos * more typos * more info * minor updates	4 years ago

Author

SHA1

Message

Date

Willem Melching

b816b5b644

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>

4 years ago

Jay Zuo

96c3bd85cf

Fixed broken link to supported cars (#22301 )

Now links to the proper page with ACC column

4 years ago

George Hotz

105be028bd

Update Docs (#22229 )

* initial move of docs

* more cleanups

* more docs

* simpler

* more docs

* link fix

* typos

* more typos

* more info

* minor updates

4 years ago

3 Commits (8160cf3c1b2726709db58219c33d1616b4a8acb5)