[Qgis-psc] PyQgis Cookbook revision

[Alexandre Neto]

In the docs meeting we have talked about splitting/removing the python
cookbook from the User manual (the same for other sections).

The advantages would be:

- We can release each document in separate
- We can break one of the docs without breaking the others
- we can have the cookbook more developers-oriented (even in the way it's
written)

The disadvantages would be:
- We would need to set intersphinx in both projects to allow keep cross
linking between them
- we would need to duplicate our sphinx project structure, and maintain it
(themes, makefiles, CI, etc...)
- If we want to go with translation, we would need to set other transifex
projects (at the meeting we kinda talked about the real need for
translation for the cookbook, quickly browsing excelpt for spanish and
french, most of other languages don't have it translated)

But anyway, like Alessandro said, the work that needs to be done, can be
performed in any of the repositories.

Alexandre Neto

On Fri, Dec 20, 2019 at 11:29 AM Alessandro Pasotti <apasotti at gmail.com>
wrote:

>
>
> 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
> _______________________________________________
> 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/20191220/2eb14749/attachment.html>