[Qgis-developer] 'Native' python docs for QGIS

Tim Sutton tim at kartoza.com
Sun Apr 16 23:56:56 PDT 2017


> On 17 Apr 2017, at 3:14 AM, Nyall Dawson <nyall.dawson at gmail.com> wrote:
> On 14 April 2017 at 09:40, Tim Sutton <tim at kartoza.com> wrote:
>> Hi All
>> I made a first pass hack to build python docs from the sip bindings for QGIS.
>> See the README & code here:
>> https://github.com/qgis/QGISPythonAPIDocumentation
>> There are a few things not yet documented like setting up sphinx etc....
> Sounds great! Have you got a sample of the output online?

Yes (same caveats apply about it being a rough first pass).


When it is more tidy I will put it on a QGIS.ORG domain - I plan to split the docs into logical subgroups  and perhaps merge it into the cookbook so that we can cross reference the API from the examples. For now I am just playing around to see what is feasible - I will hopefully put some work into it a the QGIS hackfest in Essen.

I'd also try to work up some guideline so that we can require incoming code generates nice docs. In InaSAFE we have a 'tidy everything you touch' policy - it would be nice to institute the same in QGIS so that as well as unit tests, peer reviews also require decent API docs in order for code to be merged.



> Nyall


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

Kartoza is a merger between Linfiniti and Afrispatial

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20170417/d7a1e7b0/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/20170417/d7a1e7b0/attachment-0001.jpg>

More information about the Qgis-developer mailing list