Skip to content

Commit 75a9a09

Browse files
Parse some markdown in functions
1 parent 5338f23 commit 75a9a09

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

web/resources/article.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
</div>
1212
</div>
1313

14-
{{ article.html_content }}
14+
{{ article.content_html }}

web/scripts/builder.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,23 @@ def parse_functions(self):
7979
continue
8080
if 'examples' in type_info:
8181
function["has_example"] = True
82+
for example in type_info['examples']:
83+
if 'description' in example:
84+
example['description_html'] = markdown.markdown(example['description'])
85+
8286
if 'issues' in type_info:
8387
function["has_issue"] = True
88+
for issue in type_info['issues']:
89+
issue['description_html'] = markdown.markdown(issue['description'])
90+
91+
type_info['description_html'] = markdown.markdown(type_info['description'])
92+
93+
if ('returns' in type_info) and ('description' in type_info['returns']):
94+
type_info['returns']['description_html'] = markdown.markdown(type_info['returns']['description'])
95+
96+
if 'parameters' in type_info:
97+
for parameter in type_info['parameters']:
98+
parameter['description_html'] = markdown.markdown(parameter['description'])
8499

85100
function_name = self.get_function_name(function)
86101
function["name"] = function_name
@@ -227,7 +242,7 @@ def create_article(self, article_name, articles_folder='', custom_web_path=False
227242
article['content'] = content_file.read()
228243

229244
article_template = self.input_env.get_template('article.html')
230-
article["html_content"] = markdown.markdown(article['content'])
245+
article["content_html"] = markdown.markdown(article['content'])
231246
html_content = self.render_page(
232247
article['title'],
233248
article_template.render(article=article)

0 commit comments

Comments
 (0)