[QGIS-Developer] [Plugin] Add help html documentation

[João Gaspar]

Thanks Raymond :)

I change a little bit but works perfect.

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

to

self.dlg.help_pushButton.clicked.connect(self.showHelp)


 I will try to put an example in the QGIS documentation to be more clear.

Cheers,
João AKA James :P

Raymond Nijssen <r.nijssen at terglobo.nl> escreveu no dia quarta, 22/08/2018
à(s) 14:09:

> 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
> > QGIS-Developer at lists.osgeo.org
> > 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
> QGIS-Developer at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180822/e2e5a5d3/attachment.html>