Python CSC Electronic Office
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.
Daniel Sun 010937ea17 Add group lookup functionality (#88) 4 weeks ago
.. add documentation (#22) 2 years ago update security section of docs 1 year ago
ceo.1.scd add documentation (#22) 2 years ago
ceo.ini.5.scd Add debian packaging (#32) 1 year ago
ceod.ini.5.scd Add Kubernetes API endpoint (#38) 1 year ago
openapi.yaml Add group lookup functionality (#88) 4 weeks ago
redoc-static.html Implement TUI support for multiple users in each position (#80) 2 months ago



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