Commit a501e2f2 authored by Victor Poughon's avatar Victor Poughon
Browse files

DOC: fix tag file

No related merge requests found
Showing with 6 additions and 8 deletions
+6 -8
...@@ -259,7 +259,7 @@ def detect_abuse(app): ...@@ -259,7 +259,7 @@ def detect_abuse(app):
return fake_groups return fake_groups
def rst_parameters(app): def render_parameters(app):
"Render application parameters to rst" "Render application parameters to rst"
output = "" output = ""
...@@ -378,14 +378,12 @@ def render_application(appname, allapps): ...@@ -378,14 +378,12 @@ def render_application(appname, allapps):
application_documentation_warnings(app) application_documentation_warnings(app)
parameters = rst_parameters(app)
output = template_application.format( output = template_application.format(
label="app-" + appname, label="app-" + appname,
heading=rst_section(app.GetName(), '='), heading=rst_section(app.GetName(), '='),
description=app.GetDescription(), description=app.GetDescription(),
longdescription=make_links(app.GetDocLongDescription(), allapps), longdescription=make_links(app.GetDocLongDescription(), allapps),
parameters=parameters, parameters=render_parameters(app),
examples_cli=render_all_examples_cli(app), examples_cli=render_all_examples_cli(app),
examples_python=render_all_examples_python(app), examples_python=render_all_examples_python(app),
limitations=render_limitations(app), limitations=render_limitations(app),
...@@ -428,15 +426,16 @@ def GenerateRstForApplications(rst_dir): ...@@ -428,15 +426,16 @@ def GenerateRstForApplications(rst_dir):
tags = GetApplicationTags(appName) tags = GetApplicationTags(appName)
if not tags or len(tags) == 0: if not tags or len(tags) == 0:
raise RuntimeError("No tags for application: " + appName) raise RuntimeError("No tags for application: " + appName)
tag = tags[0].replace(' ', '_') tag = tags[0]
tag_ = tag.replace(" ", "_")
# Add it to the index (i.e. https://www.orfeo-toolbox.org/CookBook/Applications.html) # Add it to the index (i.e. https://www.orfeo-toolbox.org/CookBook/Applications.html)
if not tag in writtenTags: if not tag in writtenTags:
appIndexFile.write('\tApplications/' + tag + '.rst\n') appIndexFile.write('\tApplications/' + tag_ + '.rst\n')
writtenTags.append(tag) writtenTags.append(tag)
# Create or update tag index file (e.g. https://www.orfeo-toolbox.org/CookBook/Applications/Feature_Extraction.html) # Create or update tag index file (e.g. https://www.orfeo-toolbox.org/CookBook/Applications/Feature_Extraction.html)
tagFileName = rst_dir + '/Applications/' + tag + '.rst' tagFileName = rst_dir + '/Applications/' + tag_ + '.rst'
if os.path.isfile(tagFileName): if os.path.isfile(tagFileName):
with open(tagFileName, 'a') as tagFile: with open(tagFileName, 'a') as tagFile:
tagFile.write("\tapp_" + appName + "\n") tagFile.write("\tapp_" + appName + "\n")
...@@ -446,7 +445,6 @@ def GenerateRstForApplications(rst_dir): ...@@ -446,7 +445,6 @@ def GenerateRstForApplications(rst_dir):
tagFile.write("\tapp_" + appName + "\n") tagFile.write("\tapp_" + appName + "\n")
# Write application rst # Write application rst
#print("Generating " + appName + ".rst" + " on tag " + tag)
with open(rst_dir + '/Applications/app_' + appName + '.rst', 'w') as appFile: with open(rst_dir + '/Applications/app_' + appName + '.rst', 'w') as appFile:
appFile.write(render_application(appName, appNames)) appFile.write(render_application(appName, appNames))
......
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