Commit 0221e982 authored by Cédric Traizet's avatar Cédric Traizet
Browse files

DOC: added a status string for deprecated applications in the cookbook

parent 926fa28d
......@@ -356,6 +356,12 @@ def make_links(text, allapps):
rep = {appname: ":ref:`{}`".format(appname) for appname in allapps}
return multireplace(text, rep)
def render_deprecation_string(app):
if app.IsDeprecated():
return ("This application is deprecated and will be removed in a future release.")
else:
return("")
def render_application(appname, allapps):
"Render app to rst"
......@@ -368,6 +374,7 @@ def render_application(appname, allapps):
output = template_application.format(
label=appname,
deprecation_string=render_deprecation_string(app),
heading=rst_section(app.GetName(), '='),
description=app.GetDescription(),
longdescription=make_links(app.GetDocLongDescription(), allapps),
......
.. _{label}:
{heading}
{deprecation_string}
{description}
Description
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment