TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
30267 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 1be66e43d3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1be66e43d3'
${ noResults }
openproject/doc/api_documentation_layouts
History
Oliver Günther 8dc9b592c4
Fix merge hickup 		9 years ago
..
README.md
…
openproject-includes.jade Fix merge hickup 9 years ago
openproject-layout.jade removed comments 10 years ago

README.md

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