Hi Joao,

I used it in a qgis2 plugin:


# import it:

from qgis.utils import showPluginHelp



# create help function

def showHelp(self):
    """Reacts on help button"""
    showPluginHelp(filename = 'help/index')


# connect it to some button (here in the old way):

QObject.connect(self.dlg.help_pushButton, SIGNAL("clicked()"), self.showHelp)



It is here:
https://github.com/opengeogroep/AERIUS-QGIS-plugins/blob/master/ImaerReader/imaer_reader.py

Regards,
Raymond



On 22-08-18 14:51, João Gaspar wrote:
Hi devs,
I'm using the sphinx to help documentation to a plugin. I saw in QGIS documentation that we can add documentation using the function showPluginHelp().

Where i can put the function showPluginHelp() in the plugin.py file?

Regards


_______________________________________________
QGIS-Developer mailing list
[email protected]
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer


--
Terglobo
Fahrenheitstraat 1
5223 BJ 's-Hertogenbosch
The Netherlands
+31 (0) 6 25 31 49 83
_______________________________________________
QGIS-Developer mailing list
[email protected]
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Reply via email to