<div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Dec 19, 2019 at 4:41 PM Denis Rouzaud <<a href="mailto:denis.rouzaud@gmail.com">denis.rouzaud@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">Hi all,<div><br></div><div>I was wondering if the cookbook could be integrated with the API docs website.</div><div>It would be nice, we could test everything there (it uses the QGIS docker images), and it would have a single coherente endpoint.</div><div><br></div><div>Ale, feel free to get in touch :)</div><div><br></div><div>Denis</div></div></blockquote><div><br></div><div>Hi Denis,</div><div><br></div><div>Do you you mean adding the cookbook directly in the C++ class headers? Like <a href="https://github.com/qgis/QGIS/blob/master/src/server/qgsserverogcapi.h#L33">https://github.com/qgis/QGIS/blob/master/src/server/qgsserverogcapi.h#L33</a> ?</div><div><br></div><div>This is what QT does, right?</div><div><br></div><div>If that's the case, I've thought about it and there are certainly some advantages: the most important one would probably be a unique source for code, API docs, PyQgis API docs and PyQgis recipes (the cookbook). <br></div><div>I'm not against it, but I'm not really sure it's the best option: I see the cookbook more like a "book", where there might be more space for longer paragraphs, pictures etc. and where the content can be organized independently from the Qgs* classes structure. <br></div><div><br></div><div>There are also sections in the cookbook that span across classes (the snippets mainly) or that do not really map to a single Qgs class.</div><div></div><div><br></div><div>In any event, the cookbook also uses a QGIS docker image for the python code tests (qgis/qgis:latest).</div><div><br></div><div>But maybe I totally misunderstood your proposal and you are just talking about moving the current cookbook content into another repo or suck it up when building PyQGIS API docs.<br></div><div><br></div><div>Cheers<br></div><div></div><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">Le jeu. 19 déc. 2019 à 16:04, Marco Bernasocchi <<a href="mailto:marco@qgis.org" target="_blank">marco@qgis.org</a>> a écrit :<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div>
<p>Hi Alessandro, thanks a lot for the analysis, as I already
mentioned in the docs meeting I think the py cookbook is very
important and needs lots of love.</p>
<p>I like your suggestion and I'd be in favour of doing it.</p>
<p>cheers</p>
<p>Marco<br>
</p>
<div>On 19.12.19 15:37, Alessandro Pasotti
wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr"><br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Wed, Dec 18, 2019 at 8:59
AM Paolo Cavallini <<a href="mailto:cavallini@faunalia.it" target="_blank">cavallini@faunalia.it</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">OK, if it's a quick thing
then please submit a proposal and we'll vote<br>
it ASAP.<br>
Thanks.<br>
</blockquote>
<div><br>
</div>
<div>I've done a quick research, the current cookbook
situation appears to be:</div>
<div><br>
</div>
<div>- python code samples/snippets: 202</div>
<div>- python code samples/snippets currently tested: 53</div>
<div><br>
</div>
<div>So, I think that the plan would be to:</div>
<div>1. check all the cookbook text for 3.10 API changes and
update it accordingly</div>
<div>2. put the 149 untested snippets under test<br>
</div>
<div><br>
</div>
<div>As far as point 1 is concerned the following files have
the 'outofdate' directive:</div>
<div> <br>
./source/docs/pyqgis_developer_cookbook/server.rst<br>
./source/docs/pyqgis_developer_cookbook/settings.rst<br>
./source/docs/pyqgis_developer_cookbook/network_analysis.rst<br>
./source/docs/pyqgis_developer_cookbook/canvas.rst<br>
./source/docs/pyqgis_developer_cookbook/authentication.rst<br>
./source/docs/pyqgis_developer_cookbook/plugins/ide_debugging.rst<br>
./source/docs/pyqgis_developer_cookbook/plugins/pluginlayer.rst<br>
./source/docs/pyqgis_developer_cookbook/plugins/releasing.rst<br>
./source/docs/pyqgis_developer_cookbook/raster.rst</div>
<div><br>
</div>
<div>this of course doesn't mean that all others are
necessarily uptodate, <br>
</div>
<div>but we can assume that they require less work to be
updated.</div>
<div><br>
</div>
<div>It's a bit difficult to estimate the exact amount of work
required to achieve <br>
</div>
<div>both tasks, especially because some code samples will
require quite a lot</div>
<div>of setup and data in order to run in the automatic tests.</div>
<div><br>
</div>
<div>However, I think the most efficient way to proceed is to
work on both <br>
</div>
<div>tasks simultaneously: while checking the code samples it
will be easier <br>
</div>
<div>to also apply corrections to the text.</div>
<div><br>
</div>
<div>So, what I would like to propose is to start with 5 days
of work and see where we <br>
</div>
<div>can get with that, there are probably some APIs that
haven't changed much <br>
</div>
<div>between releases (authentication is an example).<br>
</div>
<div><br>
</div>
<div>Btw, when looking at this, I've added this small
improvement: <a href="https://github.com/qgis/QGIS-Documentation/pull/4651" target="_blank">https://github.com/qgis/QGIS-Documentation/pull/4651</a></div>
<div><br>
</div>
<div>Cheers</div>
<div><br>
</div>
<div><br>
</div>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
Il 18/12/19 08:57, Alessandro Pasotti ha scritto:<br>
> <br>
> <br>
> On Wed, Dec 18, 2019 at 8:54 AM Paolo Cavallini <<a href="mailto:cavallini@faunalia.it" target="_blank">cavallini@faunalia.it</a><br>
> <mailto:<a href="mailto:cavallini@faunalia.it" target="_blank">cavallini@faunalia.it</a>>>
wrote:<br>
> <br>
> Hi Ale,<br>
> would this be suitable for a grant project?<br>
> <br>
> <br>
> <br>
> You tell me :)<br>
> <br>
> I thought I would have time to do it now in the next
few weeks, but if I<br>
> will still have time later in the year I will apply for
a grant.<br>
> <br>
> Cheers<br>
> <br>
> Cheers.<br>
> <br>
> Il 18/12/19 08:50, Alessandro Pasotti ha scritto:<br>
> > Hi,<br>
> ><br>
> > I'd like like to make a deep revision and
update of the cookbook<br>
> and put<br>
> > code snippets under automated testing.<br>
> ><br>
> > Are there any funds left for such activity?<br>
> ><br>
> > --<br>
> > Alessandro Pasotti<br>
> > w3: <a href="http://www.itopen.it" rel="noreferrer" target="_blank">www.itopen.it</a>
<<a href="http://www.itopen.it" rel="noreferrer" target="_blank">http://www.itopen.it</a>>
<<a href="http://www.itopen.it" rel="noreferrer" target="_blank">http://www.itopen.it</a>><br>
> ><br>
> >
_______________________________________________<br>
> > Qgis-psc mailing list<br>
> > <a href="mailto:Qgis-psc@lists.osgeo.org" target="_blank">Qgis-psc@lists.osgeo.org</a>
<mailto:<a href="mailto:Qgis-psc@lists.osgeo.org" target="_blank">Qgis-psc@lists.osgeo.org</a>><br>
> > <a href="https://lists.osgeo.org/mailman/listinfo/qgis-psc" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-psc</a><br>
> ><br>
> <br>
> -- <br>
> Paolo Cavallini - <a href="http://www.faunalia.eu" rel="noreferrer" target="_blank">www.faunalia.eu</a>
<<a href="http://www.faunalia.eu" rel="noreferrer" target="_blank">http://www.faunalia.eu</a>><br>
> <a href="http://QGIS.ORG" rel="noreferrer" target="_blank">QGIS.ORG</a> <<a href="http://QGIS.ORG" rel="noreferrer" target="_blank">http://QGIS.ORG</a>> Chair:<br>
> <a href="http://planet.qgis.org/planet/user/28/tag/qgis%20board/" rel="noreferrer" target="_blank">http://planet.qgis.org/planet/user/28/tag/qgis%20board/</a><br>
> _______________________________________________<br>
> Qgis-psc mailing list<br>
> <a href="mailto:Qgis-psc@lists.osgeo.org" target="_blank">Qgis-psc@lists.osgeo.org</a>
<mailto:<a href="mailto:Qgis-psc@lists.osgeo.org" target="_blank">Qgis-psc@lists.osgeo.org</a>><br>
> <a href="https://lists.osgeo.org/mailman/listinfo/qgis-psc" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-psc</a><br>
> <br>
> <br>
> <br>
> -- <br>
> Alessandro Pasotti<br>
> w3: <a href="http://www.itopen.it" rel="noreferrer" target="_blank">www.itopen.it</a>
<<a href="http://www.itopen.it" rel="noreferrer" target="_blank">http://www.itopen.it</a>><br>
<br>
-- <br>
Paolo Cavallini - <a href="http://www.faunalia.eu" rel="noreferrer" target="_blank">www.faunalia.eu</a><br>
<a href="http://QGIS.ORG" rel="noreferrer" target="_blank">QGIS.ORG</a> Chair:<br>
<a href="http://planet.qgis.org/planet/user/28/tag/qgis%20board/" rel="noreferrer" target="_blank">http://planet.qgis.org/planet/user/28/tag/qgis%20board/</a><br>
</blockquote>
</div>
<br clear="all">
<br>
-- <br>
<div dir="ltr">Alessandro Pasotti<br>
w3: <a href="http://www.itopen.it" target="_blank">www.itopen.it</a></div>
</div>
<br>
<fieldset></fieldset>
<pre>_______________________________________________
Qgis-psc mailing list
<a href="mailto:Qgis-psc@lists.osgeo.org" target="_blank">Qgis-psc@lists.osgeo.org</a>
<a href="https://lists.osgeo.org/mailman/listinfo/qgis-psc" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-psc</a></pre>
</blockquote>
<pre cols="72">--
Marco Bernasocchi
QGIS.org Co-chair
<a href="http://berna.io" target="_blank">http://berna.io</a></pre>
</div>
_______________________________________________<br>
Qgis-psc mailing list<br>
<a href="mailto:Qgis-psc@lists.osgeo.org" target="_blank">Qgis-psc@lists.osgeo.org</a><br>
<a href="https://lists.osgeo.org/mailman/listinfo/qgis-psc" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-psc</a></blockquote></div>
</blockquote></div><br clear="all"><br>-- <br><div dir="ltr" class="gmail_signature">Alessandro Pasotti<br>w3: <a href="http://www.itopen.it" target="_blank">www.itopen.it</a></div></div>