[QGIS-Developer] plugin size

[Tim Sutton]

Hi Matteo

You might want consider using the messaging framework we developed for InaSAFE. We used to use sphinx in the same way you do and struggled with it a) being very large to include in the plugin and b) requiring two separate translation workflows (Qt based and gettext based). The messaging package is currently bundled in InaSAFE here:

https://github.com/inasafe/inasafe/tree/develop/safe/messaging

But we could probably easily hive it of to its own pip package. The usage semantics allow for production of rich content which can be displaced in a web widget or exported to standalone pages. For example we produce http://manual.inasafe.org from the same code base we have in the plugin. Here is a simple example of how you use it to make a help page for a dialog:

https://github.com/inasafe/inasafe/blob/develop/safe/gui/tools/help/dock_help.py#L51

I would say the learning curve is not much higher than learning RsT and you have the advantage of your code and documentation all being managed in one place. I’d love to see this moved into QGIS core one day as I guess this is a really common requirement for plugin authors (and core devs…).

Regards

Tim


> On 29 Nov 2017, at 19:18, matteo <matteo.ghetta at gmail.com> wrote:
> 
> Hi devs,
> 
> I'm facing some issues with the plugin size and uploading. Currently the
> maximum size is around 20 MB.
> 
> The plugin [0] comes with an html manual (all done with sphinx) together
> with localization in other languages.
> 
> The problem is that when I compile the html with sphinx for all the
> languages (3 at the moment) the size exceeds the 20 MB. This happens
> because during the build sphinx copies all source images (images are
> willingly **not** localized) in all languages build folders, something
> like that:
> 
> matteo at matteo-computer:~/.local/share/QGIS/QGIS3/profiles/matteo/python/plugins/DataPlotly$
> tree help/build/html/ -L 2
> 
> help/build/html/
> ├── en
> │   ├── genindex.html
> │   ├── histogram.html
> │   ├── _images
> │   ├── index.html
> │   ├── intro.html
> │   ├── objects.inv
> │   ├── searchindex.js
> │   ├── _sources
> │   ├── _static
> │   └── ternary.html
> ├── it
> │   ├── genindex.html
> │   ├── histogram.html
> │   ├── _images
> │   ├── index.html
> │   ├── intro.html
> │   ├── objects.inv
> │   ├── searchindex.js
> │   ├── _sources
> │   ├── _static
> │   └── ternary.html
> └── nl
>    ├── genindex.html
>    ├── histogram.html
>    ├── _images
>    ├── index.html
>    ├── intro.html
>    ├── objects.inv
>    ├── searchindex.js
>    ├── _sources
>    ├── _static
>    └── ternary.html
> 
> 
> 
> the `_images` folder (for each language) weights 7MB so, basically that
> folder is the problem.
> One solution could be to copy the `_images` folder in the same directory
> of the languages, but I cannot figure out how to do this with sphinx
> options.
> 
> Has someone faced the same problem or has someone a workaround for that?
> 
> Thanks to all
> 
> Cheers
> 
> Matteo
> 
> [0] https://github.com/ghtmtt/DataPlotly/
> _______________________________________________
> 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

—







Tim Sutton

Co-founder: Kartoza
Project chair: QGIS.org

Visit http://kartoza.com <http://kartoza.com/> to find out about open source:

Desktop GIS programming services
Geospatial web development
GIS Training
Consulting Services

Skype: timlinux 
IRC: timlinux on #qgis at freenode.net

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20171130/9742768a/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: KartozaNewLogoThumbnail.jpg
Type: image/jpeg
Size: 6122 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20171130/9742768a/attachment-0001.jpg>