Commit Graph

5 Commits (master)

Author SHA1 Message Date
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
Willem Melching 3f8991a261
docker: update pip/pipenv versiosn (#22793) 2021-11-04 15:40:36 +01:00
Willem Melching 48ef2bcbf6
Small docs cleanup (#22725)
* add images

* Add root README.md to docker container
2021-10-28 19:16:39 +02:00
Willem Melching aa8952d0b1
Add sphinx dependencies to Pipfile (#22720) 2021-10-28 17:32:29 +02: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