reportsrender.build_index¶
-
reportsrender.
build_index
(html_files, output_file, title='Index')¶ Create an index file referencing all specified html files.
- Parameters
html_files (
List
[str
]) – List of documents to include in the index. The items will appear in the same order as in the list.output_file (
str
) – Path to output file. Can either end with .md or .html. In case of .html pandoc will be ran to convert the markdown file to HTML.title (
str
) – H1-title of the page