Skip to content

Commit 117244b

Browse files
authored
Merge pull request #208 from Gustry/patch-1
Update documentation for plugin development guidelines
2 parents e83735c + 02450fd commit 117244b

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

qgis-app/templates/flatpages/docs_publish.html

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,17 +112,41 @@ <h4>Tips and Tricks</h4>
112112
`plugin`.
113113
</li>
114114
<li>
115-
Plugins should make use of QgsNetworkAccessManager instead of using
116-
urllib2/requests/etc... which often fail to use correct proxy settings.
115+
Plugins should make use of
116+
<a href="https://qgis.org/pyqgis/latest/core/QgsNetworkAccessManager.html">QgsNetworkAccessManager</a>
117+
instead of using urllib2/requests/etc... which often fail to use correct proxy settings.
118+
</li>
119+
<li>
120+
Plugins should make use of QGIS widgets, such as
121+
<a href="https://qgis.org/pyqgis/latest/gui/QgsMapLayerComboBox.html">QgsMapLayerComboBox</a>
122+
for a drop down menu with layers.
123+
Other widgets are available, check the <a href="https://qgis.org/pyqgis/latest/gui/index.html">list on the documentation</a>.
117124
</li>
118125
<li>
119126
The
120-
<a title="Plugin builder" href="/plugins/pluginbuilder3/"
121-
>plugin builder</a
127+
<a title="QGIS Plugin Templater GUI" href="/plugins/qgis_plugin_templater_gui/"
128+
>QGIS Plugin Templater GUI</a
129+
> or
130+
<a title="QGIS Minimal Plugin" href="https://github.com/wonder-sk/qgis-minimal-plugin"
131+
>QGIS Minimal Plugin</a
122132
>
123-
plugin is recommended, especially for new users.
124-
</li>
125-
</ul>
133+
are recommended.
134+
</li>
135+
<li>
136+
Experienced developers with quality standards for quality and tools and used to git workflow are encouraged to use
137+
one of the well-known <a title="Cookiecutter" href="https://cookiecutter.readthedocs.io/" target="_blank">Cookiecutter</a>
138+
templates:
139+
<ul>
140+
<li>
141+
<a title="QGIS Plugin Templater" href="https://oslandia.gitlab.io/qgis/template-qgis-plugin/" target="_blank">QGIS Plugin Templater</a>
142+
(used behind the scenes of the plugin listed above)
143+
</li>
144+
<li>
145+
<a title="Cookiecutter QGIS Plugin" href="https://github.com/GispoCoding/cookiecutter-qgis-plugin" target="_blank">Cookiecutter QGIS Plugin</a>
146+
</li>
147+
</ul>
148+
</li>
149+
</ul>
126150
<div
127151
id="_mcePaste"
128152
class="mcePaste"

0 commit comments

Comments
 (0)