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.
58670 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: b2b307c4e2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b2b307c4e2'
${ noResults }
openproject/docs/api/api_documentation_layouts
History
luz paz 3683042c9b
Fix typos in user facing and non-user facing code 		4 years ago
..
README.md Fix typos in user facing and non-user facing code 4 years ago
openproject-includes.jade Rename doc to docs and restructure operations folder 8 years ago
openproject-layout.jade Rename doc to docs and restructure operations folder 8 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 output 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