HTMLExporter¶
-
class
qf_lib.documents_utils.document_exporting.html_exporter.
HTMLExporter
(settings: qf_lib.settings.Settings)[source]¶ Bases:
qf_lib.documents_utils.document_exporting.document_exporter.DocumentExporter
Stores a number of documents, which represent a single subreport, in order to then generate HTML for each of them.
Methods
generate
(documents, export_dir, filename[, …])Generates HTML pages for each document in this builder.
-
generate
(documents: List[qf_lib.documents_utils.document_exporting.document.Document], export_dir: str, filename: str = None, include_table_of_contents=True) → List[str][source]¶ Generates HTML pages for each document in this builder. The resulting HTML will be saved in the output directory, the filename will be the same as the Document’s
name
field unless thefilename
parameter is specified, in which case there will only be one HTML file saved.
-