sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-05-03 00:03:15 -04:00
Code Issues Packages Projects Releases Wiki Activity

[processing] rst files are now the default for help files

Browse Source
This commit is contained in:
Victor Olaya 2014-06-08 19:57:22 +02:00
parent 2073026f7c
commit d8dfdd25f1
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
python/plugins/processing/core/GeoAlgorithm.py
View File

@ -25,6 +25,7 @@ __copyright__ = '(C) 2012, Victor Olaya'
__revision__ = '$Format:%H$' __revision__ = '$Format:%H$'
import inspect
import os.path import os.path
import traceback import traceback
import copy import copy
@ -32,6 +33,7 @@ from PyQt4 import QtGui
from PyQt4.QtCore import * from PyQt4.QtCore import *
from qgis.core import * from qgis.core import *
from processing.gui.Help2Html import getHtmlFromRstFile
from processing.core.ProcessingLog import ProcessingLog from processing.core.ProcessingLog import ProcessingLog
from processing.core.ProcessingConfig import ProcessingConfig from processing.core.ProcessingConfig import ProcessingConfig
from processing.core.GeoAlgorithmExecutionException import \ from processing.core.GeoAlgorithmExecutionException import \
@ -112,12 +114,26 @@ class GeoAlgorithm:
"""Returns the help with the description of this algorithm. """Returns the help with the description of this algorithm.
It returns a tuple boolean, string. IF the boolean value is true, it means that It returns a tuple boolean, string. IF the boolean value is true, it means that
the string contains the actual description. If false, it is an url or path to a file the string contains the actual description. If false, it is an url or path to a file
where the description is stored where the description is stored.
Returns None if there is no help file available. Returns None if there is no help file available.
The default implementation looks for an rst file in a help folder under the folder
where the algorithm is located.
The name of the file is the name console name of the algorithm, without the namespace part
""" """
name = self.commandLineName().split(':')[1].lower()
filename = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), 'help', name + '.rst')
print filename
try:
html = getHtmlFromRstFile(filename)
print html
return True, html
except:
print "error"
return False, None return False, None
def processAlgorithm(self): def processAlgorithm(self):
"""Here goes the algorithm itself. """Here goes the algorithm itself.

2
python/plugins/processing/gui/Help2Html.py
View File

@ -45,7 +45,7 @@ exps = [(r"\*(.*?)\*", r"<i>\1</i>"),
def getHtmlFromRstFile(rst): def getHtmlFromRstFile(rst):
if not os.path.exists(rst): if not os.path.exists(rst):
return '' return None
with open(rst) as f: with open(rst) as f:
lines = f.readlines() lines = f.readlines()
s = "".join(lines) s = "".join(lines)