Theodolite Docs
Theodolite's docs are generated with Jekyll from Markdown files.
Installation
To set up Jekyll run:
gem install bundler
bundle config set --local path 'vendor'
bundle installLocal Testing
For live serving the docs run:
bundle exec jekyll serveBuilding
You can compile everything to HTML via:
bundle exec jekyll buildCRD API Reference
We use the crdoc tool to generate the API reference for our CRDs:
crdoc --resources ../theodolite/crd/ --template api-reference/crds.tmpl --output api-reference/crds.mdWith the following command, crdoc is executed in Docker:
docker run --rm -v "`pwd`/../theodolite/crd/":/crd -v "`pwd`/api-reference":/api-reference ghcr.io/fybrik/crdoc:0.6.1 --resources /crd/ --template /api-reference/crds.tmpl --output /api-reference/crds.md