<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Wed, Mar 8, 2017 at 9:34 AM, Nathan Woodrow <span dir="ltr"><<a href="mailto:madmanwoo@gmail.com" target="_blank">madmanwoo@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><p dir="ltr">I'm not sure we need the headers in the sip files to make a python docs API do we. That is the first thing to work out.</p></blockquote><div><br></div><div>I don't know, all I know is that you can build API docs with doxygen using sip files as a source: this is an ancient try that I did a few years ago <a href="http://www.itopen.it/qgis/serverplugins/api/classQgsServerInterface.html">http://www.itopen.it/qgis/serverplugins/api/classQgsServerInterface.html</a><br><br></div><div>The result is far from ideal though, but maybe it could be refined.<br></div><div>There might be other ways to build the Python API docs, like using introspection, but I'm not sure about how can we grab the documentation from the C++ headers if we go that route.<br><br></div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br><div class="gmail_quote"><div><div class="gmail-h5"><div dir="ltr">On Wed, 8 Mar 2017 6:23 pm Alessandro Pasotti <<a href="mailto:apasotti@gmail.com" target="_blank">apasotti@gmail.com</a>> wrote:<br></div></div></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div><div class="gmail-h5"><div dir="ltr" class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg">Hi,<br class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"></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 class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"></div>As a Python QGIS developer, what I probably need is:<br class="gmail-m_2676634982651297337gmail_msg"></div>1. Python API docs, possibly with examples<br class="gmail-m_2676634982651297337gmail_msg"></div>2. Developer documentation about how to write PyQGIS plugins and standalone applications<br class="gmail-m_2676634982651297337gmail_msg"></div>3. Tutorials and examples<br class="gmail-m_2676634982651297337gmail_msg"></div>4. Scaffolding<br class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"></div><div class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"></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 class="gmail-m_2676634982651297337gmail_msg">4. is perfectly covered by plugin builders<br class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg">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 class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"></div><div class="gmail-m_2676634982651297337gmail_msg">There have been some efforts to build PyQGIS API documentation: <a href="http://geoapis.sourcepole.com/qgispyapi/qgisinterface" class="gmail-m_2676634982651297337gmail_msg" target="_blank">http://geoapis.sourcepole.com/<wbr>qgispyapi/qgisinterface</a> , maybe Sourcepole colleagues could share their experience in building that pages.<br class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"></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 class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg"></div><div class="gmail-m_2676634982651297337gmail_msg">What do you think about this?<br class="gmail-m_2676634982651297337gmail_msg"></div><div class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg" clear="all"></div><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337gmail_msg"><br class="gmail-m_2676634982651297337gmail_msg">-- <br class="gmail-m_2676634982651297337gmail_msg"><div class="gmail-m_2676634982651297337m_-8898174341362392353gmail_signature gmail-m_2676634982651297337gmail_msg">Alessandro Pasotti<br class="gmail-m_2676634982651297337gmail_msg">w3:   <a href="http://www.itopen.it" class="gmail-m_2676634982651297337gmail_msg" target="_blank">www.itopen.it</a></div>
</div></div></div></div></div></div></div></div></div></div></div></div>
______________________________<wbr>_________________<br class="gmail-m_2676634982651297337gmail_msg">
Qgis-developer mailing list<br class="gmail-m_2676634982651297337gmail_msg">
<a href="mailto:Qgis-developer@lists.osgeo.org" class="gmail-m_2676634982651297337gmail_msg" target="_blank">Qgis-developer@lists.osgeo.org</a><br class="gmail-m_2676634982651297337gmail_msg">
List info: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" class="gmail-m_2676634982651297337gmail_msg" target="_blank">https://lists.osgeo.org/<wbr>mailman/listinfo/qgis-<wbr>developer</a><br class="gmail-m_2676634982651297337gmail_msg">
Unsubscribe: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" class="gmail-m_2676634982651297337gmail_msg" target="_blank">https://lists.osgeo.org/<wbr>mailman/listinfo/qgis-<wbr>developer</a></blockquote></div>
</blockquote></div><br><br clear="all"><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>