[Qgis-psc] PyQgis Cookbook revision

Alessandro Pasotti apasotti at gmail.com
Fri Dec 20 03:29:33 PST 2019


On Fri, Dec 20, 2019 at 12:22 PM DelazJ <delazj at gmail.com> wrote:

> Hi all,
>
> Quick points
>
Le ven. 20 déc. 2019 à 11:54, Alessandro Pasotti <apasotti at gmail.com> a
> écrit :
>
>>
>> [...]
>>
>> Whether the whole Python developers guide (cookbook + API) is an external
>> link or not is probably not so important, except maybe for browsability
>> from the main website and search capabilities from the main website.
>>
>> The intersphinx  extension helps to reach Python API documentation from
> within the Cookbook or the User manual. The reverse is not (yet?) true and
> I don't know whether it's easy to do.
>
> Both the Python part and the C++ part are actually a mix of three separate
>> topics:
>> - core development (C++ and core Python plugins and processing core algs)
>> - independent plugins (both C++ even if they are not very welcome lately
>> and Python).
>> - standalone applications
>>
>> In any event, if I get this right, moving the cookbook to a different
>> sphinx project doesn't change much about the cookbook revision work I'm
>> proposing to do, we can probably just move the doctest target into the
>> python API project.
>>
>> But I wonder if moving the cookbook out of the documentation doesn't
>> create a problem with translations, I didn't check if there are any for the
>> cookbook.
>>
>> Every document under qgis/QGIS-Documentation repository is currently
> translated.
>


Hm, so I guess this is a blocker, right?

@Denis Rouzaud <denis.rouzaud at gmail.com>  given that the system to run CI
tests on the Python code embedded in the cookbook is already in place, what
are the technical advantages of moving the cookbook into the Python API
sphinx project?



>
> Regards,
> Harrissou
>
> I think we should bring the documentation team into the discussion, is
>> there a better place than this list where they have a better chance to get
>> involved?
>>
>> Cheers
>>
>> --
>> Alessandro Pasotti
>> w3:   www.itopen.it
>> _______________________________________________
>> Qgis-psc mailing list
>> Qgis-psc at lists.osgeo.org
>> https://lists.osgeo.org/mailman/listinfo/qgis-psc
>
>

-- 
Alessandro Pasotti
w3:   www.itopen.it
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20191220/38ce4c98/attachment.html>


More information about the Qgis-psc mailing list