You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
758 B
758 B
Documentation
OpenAPI
We are using OpenAPI 3.0 to document the REST API for ceod, and Redoc to generate HTML documentation from the OpenAPI file.
First, make sure you have Node.js and npm installed. Then, install the Redoc CLI:
npm install -g redoc-cli
After you make changes to the openapi.yaml file, make sure to regenerate the HTML:
redoc-cli bundle openapi.yaml
You can now view the redoc-static.html file from your browser.
Man pages
We are using scdoc to generate our man pages. You can view the pages from your terminal like so:
scdoc < ceo.1.scd > ceo.1
man ./ceo.1