[Qgis-psc] Work on PyQGIS docs

Denis Rouzaud denis.rouzaud at gmail.com
Wed Oct 16 00:39:49 PDT 2019


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
* add return types and param rtype (and links within the API docs)
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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20191016/6ebfbd61/attachment.html>


More information about the Qgis-psc mailing list