public
/
pyceo
24
1
Fork 2
Code Issues 14 Pull Requests 2 Projects Releases 1 Wiki Activity
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.
623 Commits
4 Branches
9 Tags
8.6 MiB
 
 
 
 
Tag: Branch: Tree: b4110d887d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b4110d887d'
${ noResults }
pyceo/docs
History
Max Erenberg a7c5098b67
continuous-integration/drone/push Build is passing
Details
Add cloud vhost API (#35) 		1 year ago
..
README.md add documentation (#22) 1 year ago
architecture.md Add isClubRep attribute (#27) 1 year ago
ceo.1.scd add documentation (#22) 1 year ago
ceo.ini.5.scd Add debian packaging (#32) 1 year ago
ceod.ini.5.scd Add debian packaging (#32) 1 year ago
openapi.yaml Add cloud vhost API (#35) 1 year ago
redoc-static.html Add cloud vhost API (#35) 1 year ago

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