diff options
Diffstat (limited to 'docs/api.md')
| -rw-r--r-- | docs/api.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..647e3a3 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,20 @@ +# API + +The API mostly consist of two helper classes and the domain model. For the domain model, see the domain documentation. + +## qface.generator.FileSystem + +* 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 |