[Qgis-psc] pyqgis docs

[Denis Rouzaud]

Hi Anita,

Thanks a lot for doingi it, nicely written!
I'll just maybe complete a bit the technical part.
I'd like also to insist on PyQGIS term, so it gets more widely used.
I write directly in your text.
Feel free to correct my corrections ;) your english sounds a bit better
than mine! Or, if you find them too technical.

Cheers,
Denis


> We are proud to announce our new dedicated documentation of the Python API
> (also called PyQGIS). It is available at https://qgis.org/pyqgis
>
> While the QGIS API has long been documented, Python developers in the past
> had to work with the general C++ documentation that wasn't always
> straightforward to use. The new PyQGIS documentation presents the API in an
> accessible pythonic manner.
>
Bringing a generated API for Python from source code was not a trivial
> task.
>
The fitst challenge was the automatic creation of the Python bindings files
> (or SIP files) which was achieved by developing a custom perl script known
> as "sipify". This allows us to automatically introduce and keep up to date
> the C++ documentation into the Python bindings.
>
 Next, was the creation of the documentation itself using Sphinx. Two
> detailed reports containing all the technical details of the first
> <https://cloud.opengis.ch/index.php/s/n6HBCzPWrWqa5di> and second
> <https://lists.osgeo.org/pipermail/qgis-psc/2018-April/006090.html>
> generation of the documentation are available if you want to learn more
> about the underlying architecture.
>
This has been a really important infrastructure project for QGIS that has
> been made possible by support from or donors and sponsors
> <https://qgis.org/en/site/about/sponsorship.html#>, as well as the
> generous in-kind contributions of our community members.
>
> Regards,
> Anita
>
>
>
> On Wed, May 16, 2018 at 1:49 PM, Denis Rouzaud <denis.rouzaud at gmail.com>
> wrote:
>
>> Hi Guys,
>>
>> Yes, everything is ready.
>>
>> I don't know if it makes a lot of sense to enter technical details?
>> There have been 2 reports:
>> 1. https://cloud.opengis.ch/index.php/s/n6HBCzPWrWqa5di
>> 2. https://lists.osgeo.org/pipermail/qgis-psc/2018-April/006090.html
>>
>> Anita, let me know if you want to write a more attractive summary? In
>> such case, with an approximate number of lines/words (more like 3-5 lines
>> or 1--20 lines...)
>>
>> Cheers,
>>
>> Denis
>>
>> Le mer. 16 mai 2018 à 06:55, Anita Graser <anitagraser at gmx.at> a écrit :
>>
>>> On Wed, May 16, 2018 at 12:40 PM, Richard Duivenvoorde <
>>> rdmailings at duif.net> wrote:
>>>
>>>> On 16-05-18 12:28, Anita Graser wrote:
>>>>
>>>> > ​We should definitely fix the link in
>>>> >
>>>> http://blog.qgis.org/2018/05/08/reports-from-the-winning-grant-proposals-2017/
>>>>
>>>> > which mentions the pyqgis doc efforts in the end.
>>>> >
>>>> > I'm also fine with publishing another blog post. Do we have something
>>>> > new to say besides the link?
>>>>
>>>> I think we could make it a more technical post with some input of Denis?
>>>>
>>>
>>> ​Ok, I had some more technical details, which I didn't include in the
>>> blog post.
>>> I can whip something up in the next days.
>>>
>>> Further input welcome!
>>>
>>> Anita
>>>
>>> ​
>>>
>>>
>>>
>>>
>>>>
>>>> Why was this needed, how is it served etc.
>>>>
>>>> Note that the main github repo also changed. In the article it links to:
>>>> https://github.com/opengisch/QGISPythonAPIDocumentation
>>>> But the main work is now done on:
>>>> https://github.com/qgis/pyqgis
>>>>
>>>> Regards,
>>>>
>>>> Richard
>>>> _______________________________________________
>>>> Qgis-psc mailing list
>>>> Qgis-psc at lists.osgeo.org
>>>> https://lists.osgeo.org/mailman/listinfo/qgis-psc
>>>>
>>> _______________________________________________
>>> Qgis-psc mailing list
>>> Qgis-psc at lists.osgeo.org
>>> https://lists.osgeo.org/mailman/listinfo/qgis-psc
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20180519/289ee7f5/attachment.html>