Commit Graph

6 Commits (master)

Author SHA1 Message Date
Adeeb Shihadeh d468d6e890 docs: fix title typo 2022-02-21 13:30:56 -08:00
Willem Melching 9720dbe9b9 docs: conf.py dont shadow project variable 2022-01-04 17:40:00 +01:00
Andrew 9f70bea964
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 4c44c02ffb.

* its in the dockerfile

Co-authored-by: Willem Melching <willem.melching@gmail.com>
2022-01-04 17:26:07 +01:00
Andrew c86ca387c2
add version to docs.comma.ai (#23260)
* update conf:
* add logo and favicon from connect.comma.ai
* add version

* proper version extract

* v

* Update docs/conf.py

Co-authored-by: Willem Melching <willem.melching@gmail.com>
2021-12-29 17:31:56 +01:00
Andrew c95202bd1c
docs.comma.ai add sitemap and robots.txt (#23259)
* add sitemap generator

* update conf for seo

* remove cmake var

* relock

* fix html_baseurl

* more fixes

* newline

Co-authored-by: Willem Melching <willem.melching@gmail.com>
2021-12-28 18:07:32 +01:00
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>
2021-10-28 15:14:37 +02:00