aboutsummaryrefslogtreecommitdiff
path: root/resumejson_converter/generators
diff options
context:
space:
mode:
Diffstat (limited to 'resumejson_converter/generators')
-rw-r--r--resumejson_converter/generators/html.py8
-rw-r--r--resumejson_converter/generators/pdf.py4
2 files changed, 12 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)
diff --git a/resumejson_converter/generators/pdf.py b/resumejson_converter/generators/pdf.py
index de3e880..b8c2905 100644
--- a/resumejson_converter/generators/pdf.py
+++ b/resumejson_converter/generators/pdf.py
@@ -5,6 +5,10 @@ import pdfkit
def generate(html):
+ """
+ Generate a pdf file in out/out.pdf in current folder where main script
+ is executed.
+ """
logging.info("PDF generation...")
pdf_output_path = "out/out.pdf"