planetfederal / qgis-geogiglight-plugin

GNU General Public License v2.0
19 stars 9 forks source link

builddocs paver task allow to control the output theme #113

Closed SrNetoChan closed 6 years ago

SrNetoChan commented 6 years ago

For plugins documentation, we use more than one sphinx theme.

To publish plugins documentation in the Boundless connect portal, we use a Boundless Desktop theme called boundless_product.

image

For documentation shipped with plugins as offline help, we use a generic boundless theme called boundless_doc. This is the default theme used as set in conf.py. The reasoning is that our plugins may be used in the official QGIS, so we better promote the company.

image

With this change (that I would extend to all our plugins) we can choose to use the default theme by running:

paver builddocs

Or choose the name of the alternative sphinx theme:

paver builddocs -s boundless_product