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 install

Local Testing

For live serving the docs run:

bundle exec jekyll serve

Building

You can compile everything to HTML via:

bundle exec jekyll build

CRD API Reference

We use the crdoc tool to generate the API reference for our CRDs.

crdoc --resources ../theodolite/crd/ --output api-reference/crds.md