<div dir="ltr"><div><div><div><div><div><div><div>Hi,<br><br></div>I think we still lack a up-to-date comprehensive documentation targeted to Python QGIS developers and I would like to discuss the options that we have to improve the current situation.<br><br></div>As a Python QGIS developer, what I probably need is:<br></div>1. Python API docs, possibly with examples<br></div>2. Developer documentation about how to write PyQGIS plugins and standalone applications<br></div>3. Tutorials and examples<br></div>4. Scaffolding<br><br></div><div><br></div>2 and 3. the cookbook is doing a very good job, but it could probably be improved and kept in sync with the API changes<br>4. is perfectly covered by plugin builders<br><div><div><div><div><div><div><div>1. this is were IMO we should do better: for most experienced QGIS developers it's perfectly fine to look at the C++ API docs, but I think that for Python developers that is not ideal<br><br></div><div>There have been some efforts to build PyQGIS API documentation: <a href="http://geoapis.sourcepole.com/qgispyapi/qgisinterface">http://geoapis.sourcepole.com/qgispyapi/qgisinterface</a> , maybe Sourcepole colleagues could share their experience in building that pages.<br><br></div>My main concern here is that we are slowly moving away from documenting SIP files, I don't know if we can still build PyQGIS documentation without documenting the SIP files but we should think carefully before taking a move that will block us from using SIP files as a source for building the docs.<br><br><br></div><div>What do you think about this?<br></div><div><br clear="all"></div><div><div><div><div><br>-- <br><div class="gmail_signature">Alessandro Pasotti<br>w3:   <a href="http://www.itopen.it" target="_blank">www.itopen.it</a></div>
</div></div></div></div></div></div></div></div></div></div>