aboutsummaryrefslogtreecommitdiff
path: root/resumejson_converter/generators/html.py
diff options
context:
space:
mode:
Diffstat (limited to 'resumejson_converter/generators/html.py')
-rw-r--r--resumejson_converter/generators/html.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/resumejson_converter/generators/html.py b/resumejson_converter/generators/html.py
index 57df871..1b34e91 100644
--- a/resumejson_converter/generators/html.py
+++ b/resumejson_converter/generators/html.py
@@ -9,6 +9,14 @@ import resumejson_converter.filters as filters
def generate(resume, template, out_path):
+ """
+ Return html version of a JSON resume based on a template.
+
+ `resume` is a JsonObject from resumejson_converter.utils.json.
+ `template` is the path of the template to use.
+ `out_path` is the output path of html generate. By default the html is
+ not writen in a file.
+ """
try:
logging.info("HTML generation...")
templates_path = path.dirname(template)