app.model.lib.help_topics

Classes

HelpTopics

A class that reads help topic templates as markdown or HTML and provides an

Module Contents

class app.model.lib.help_topics.HelpTopics(templates_dir, help_topic_dir)

A class that reads help topic templates as markdown or HTML and provides an interface to search through their text.

Reads the code once with the process_once method and stores the contents in memory.

Depends on Flask’s render_template to evaluate the templates as jinja2. In the future, it might be nice to isolate it from these, but for now, it does the job and nothing else depends on the class, so it’s fine as it is.

templates_dir

help_topic_dir

markdown

word_count = 0

render_html(base_path)

search(query)

process_once(debug=False)