public
/
pyceo
27
1
Fork 3
Code Issues 25 Pull Requests 5 Projects Releases 1 Wiki Activity
pyceo/docs
History
Max Erenberg 02aff43e7f
continuous-integration/drone/push Build is failing Details
Add debian packaging (#32) 
Closes #31.

Co-authored-by: Max Erenberg <>
Reviewed-on: #32
Co-authored-by: Max Erenberg <merenber@csclub.uwaterloo.ca>
Co-committed-by: Max Erenberg <merenber@csclub.uwaterloo.ca>
 		2021-10-28 20:52:19 -04:00
..
README.md add documentation (#22) 2021-10-05 00:07:10 -04:00
architecture.md Add isClubRep attribute (#27) 2021-10-23 10:23:43 -04:00
ceo.1.scd add documentation (#22) 2021-10-05 00:07:10 -04:00
ceo.ini.5.scd Add debian packaging (#32) 2021-10-28 20:52:19 -04:00
ceod.ini.5.scd Add debian packaging (#32) 2021-10-28 20:52:19 -04:00
openapi.yaml Use inetOrgPerson instead of account (#29) 2021-10-23 23:21:09 -04:00
redoc-static.html Use inetOrgPerson instead of account (#29) 2021-10-23 23:21:09 -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