diff options
author | Juergen Ryannel <juergen.bocklage-ryannel@pelagicore.com> | 2016-11-30 17:13:47 +0100 |
---|---|---|
committer | Juergen Ryannel <juergen.bocklage-ryannel@pelagicore.com> | 2016-11-30 17:13:47 +0100 |
commit | 2d06f1ec72ec35a4c5b411eb9ebbdc0a5f283a44 (patch) | |
tree | b1bf0221e52257477db6c714897abed3acbd39a1 /docs | |
parent | a762f54c682076bdb394990d3d938242e6a0dd23 (diff) |
WIP: api documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api.md | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md index f6f4c44..647e3a3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -4,4 +4,17 @@ The API mostly consist of two helper classes and the domain model. For the domai ## qface.generator.FileSystem -## qface.generator.Generator
\ No newline at end of file +* FileSystem.parse_document(path: str, system: System = None) +* FileSystem.parse_dir(path, identifier: str = None, clear_cache=True) +* FileSystem.find_files(path, glob='*.qdl') + +## qface.generator.Generator + +* Generator(searchpath) + Manages the templates and applies your context data +* generator.get_template(self, name: str) + Retrievs a single template file from the template loader +* generator.render(self, name: str, context: dict) +* generator.apply(self, template: Template, context: dict) +* generator.write(self, fileTemplate: str, template: str, context: dict) +* generator.register_filter(self, name, callback)
\ No newline at end of file |