OpenProject is the leading open source project management software.
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.
 
 
 
 
 
 
openproject/doc/api_documentation_layouts/README.md

1.7 KiB

API Documentation Layouts

API Version 3

Status: under development

The documentation for APIv3 is written in the API Blueprint Format.

You can use aglio to generate HTML documentation. Aglio supports the use of templates to adjust the ouput to your own needs. OpenProject is using the openproject.jade template file. To generate the documentation using the openproject.jade layout file the following command:

aglio -t openproject-layout.jade -i ../apiv3-documentation.api -o api.html