public
/
pyceo
27
1
Fork 3
Code Issues 25 Pull Requests 5 Projects Releases 1 Wiki Activity
pyceo/docs
History
Max Erenberg 1fcc49ef12
continuous-integration/drone/push Build is passing Details
add documentation (#22) 
Add OpenAPI spec and man pages

Co-authored-by: Max Erenberg <>
Co-authored-by: Rio Liu <rio.liu@r26.me>
Co-authored-by: Andrew Wang <a268wang@csclub.uwaterloo.ca>
Reviewed-on: #22
Co-authored-by: Max Erenberg <merenber@csclub.uwaterloo.ca>
Co-committed-by: Max Erenberg <merenber@csclub.uwaterloo.ca>
 		2021-10-05 00:07:10 -04:00
..
README.md add documentation (#22) 2021-10-05 00:07:10 -04:00
ceo.1.scd add documentation (#22) 2021-10-05 00:07:10 -04:00
ceo.ini.5.scd add documentation (#22) 2021-10-05 00:07:10 -04:00
ceod.ini.5.scd add documentation (#22) 2021-10-05 00:07:10 -04:00
openapi.yaml add documentation (#22) 2021-10-05 00:07:10 -04:00
redoc-static.html add documentation (#22) 2021-10-05 00:07:10 -04:00

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