evariste.plugins.renderer.html
¶
Render tree as an HTML (body) page.
- class evariste.plugins.renderer.html.HTMLRenderer(shared: Shared)[source]¶
Render tree as an HTML div (without the
<div>
tags).The default template name is
tree.html
, and such a default template is found in one of the template directories.- default_setup: Dict[str, str] = {'destfile': 'index.html', 'href_prefix': ''}¶
Default value for section
self.keyword
in the setup file. It may be overwritten by data provided by user in the setup file. See Plugin.default_setup and Plugin.global_default_setup.
- depends: Iterator[str] = ['renderer.html.readme.html', 'renderer.html.file.default']¶
Iterable of plugins this plugin depends on. When this plugin is enabled, those plugins are enabled as well.
- keyword: Union[None, str] = 'renderer.html'¶
Keyword plugin, used to reference it: it is used to enable plugins in the setup file, to name its section in the setup file, etc.
- template: str = 'tree.html'¶
Default template. This can be overloaded in the setup file. The template is looked for in any of the templatedirs.
evariste.plugins.renderer.html.file
¶
Default HTML file renderer
- class evariste.plugins.renderer.html.file.HtmlFileRenderer(shared)[source]¶
Default HTML file renderer.
This displays the file name together with the file source.
To write another file renderer, you can:
define a new
template
to use:overwrite the default
match()
method;overwrite the default
render()
method.
- extension: Optional[str] = 'html'¶
Extension that is automatically added at the end of the template name when searching them.
- keyword: Union[None, str] = 'renderer.html.file.default'¶
Keyword plugin, used to reference it: it is used to enable plugins in the setup file, to name its section in the setup file, etc.
evariste.plugins.renderer.html.readme
¶
Raw README plugin for html renderer.
- class evariste.plugins.renderer.html.readme.HtmlReadmeRenderer(shared)[source]¶
Html renderer for readme files, using jinja2 template engine.
It uses the row content of the
html
README.- extensions: List[str] = ['html', 'htm']¶
List of extensions of the READMEs (see
Jinja2ReadmeRenderer
).
- keyword: Union[None, str] = 'renderer.html.readme.html'¶
Keyword plugin, used to reference it: it is used to enable plugins in the setup file, to name its section in the setup file, etc.