[Qgis-psc] Work on PyQGIS docs

[Tim Sutton]

Hi

Hurrah! Thank you so much for this Denis! If we move to Qt for Python one day will we have a massive job porting the API docs?

Regards

Tim

> On 16 Oct 2019, at 08:39, Denis Rouzaud <denis.rouzaud at gmail.com> wrote:
> 
> Dear PSC, 
> 
> I have spent the 3 days on improving the PyQGIS docs.
> Here is what has been done:
> 
> * refactoring of the build scripts (much clearer now)
> * updating the forked theme (to support versioning) with upstream
> * added processing to the documentation (still some work to be done here)
> * remove empty sections (enum, signal, attributes) in pages  https://github.com/qgis/pyqgis/pull/40 <https://github.com/qgis/pyqgis/pull/40>
> * add return types and param rtype (and links within the API docs) https://github.com/qgis/pyqgis/pull/41 <https://github.com/qgis/pyqgis/pull/41>
> 
> The last one was a tricky one. We currently cannot use existing tools (like sphinx-auto-typehints) since SIP does not fill the __annotations__ dictionary. Maybe another reason to look towards Qt for Python. Anyway, I added custom event handler around autodoc to manually process the docstring.
> 
> I believe this was a good shot for the docs, and I guess we would benefit from having such maintenance and small improvements sponsored work each year. Of course, I'm blowing my own horn, and I'd like to propose my application for next year. 
> 
> Thanks for your confidence.
> Denis
> 
> _______________________________________________
> Qgis-psc mailing list
> Qgis-psc at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-psc

—









Tim Sutton

Co-founder: Kartoza
Ex 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

I'd love to connect. Here's my calendar link <https://calendly.com/timlinux> to make finding time easy.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20191016/0b37b804/attachment.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-psc/attachments/20191016/0b37b804/attachment.jpg>