Jonathan Leung
b507c56136
continuous-integration/drone/push Build is passing
Details
Closes #69. Tests are failing locally with many `assert os.geteuid() == 0` errors even on the master branch. I will add tests after I figure this out. Reviewed-on: #82 Co-authored-by: Jonathan Leung <j23leung@csclub.uwaterloo.ca> Co-committed-by: Jonathan Leung <j23leung@csclub.uwaterloo.ca> |
||
---|---|---|
.. | ||
README.md | ||
architecture.md | ||
ceo.1.scd | ||
ceo.ini.5.scd | ||
ceod.ini.5.scd | ||
openapi.yaml | ||
redoc-static.html |
README.md
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