diff --git a/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py b/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py index 8cd9ab8ed70e204d915e32c25ebb4944f52b4a9b..644f9a78c5d0e934bc1be63908a28cc8c79b0885 100755 --- a/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py +++ b/Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py @@ -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), diff --git a/Documentation/Cookbook/rst/templates/application.rst b/Documentation/Cookbook/rst/templates/application.rst index 68db4a8b3cc9c224fcdc107d8c4e3f9f21f97329..bbe15bceff737e5f165a2bdea7d4ea17771fcaab 100644 --- a/Documentation/Cookbook/rst/templates/application.rst +++ b/Documentation/Cookbook/rst/templates/application.rst @@ -1,6 +1,9 @@ .. _{label}: {heading} + +{deprecation_string} + {description} Description