Re: [QGIS-Developer] Processing doc - sphinx - anchors

[Alexander Bruy]

Should be fixed now. Please check.

2018-02-24 18:05 GMT+02:00 Alexander Bruy :
> Ah I see. I will try to find a workaround.
>
> 2018-02-24 18:04 GMT+02:00 matteo :
>>> If I'm not wrong you already asked about it and Nyall had implemented this
>>
>> yes that's right, but with was for groups and not single algorithm
>> names. With your fix of some hour ago the link of native algorithm looks
>> like:
>>
>> https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#nativepackage
>>
>> and not
>>
>> https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#qgispackage
>>
>> but that's alright. I'm changing the names manually. So I'll leave this
>> as it is and I think we really need to add a chapter to the
>> documentation guidelines for Processing (I'll do that).
>>
>> Thanks
>>
>> Matteo
>
>
>
> --
> Alexander Bruy



-- 
Alexander Bruy
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[Alexander Bruy]

Ah I see. I will try to find a workaround.

2018-02-24 18:04 GMT+02:00 matteo :
>> If I'm not wrong you already asked about it and Nyall had implemented this
>
> yes that's right, but with was for groups and not single algorithm
> names. With your fix of some hour ago the link of native algorithm looks
> like:
>
> https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#nativepackage
>
> and not
>
> https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#qgispackage
>
> but that's alright. I'm changing the names manually. So I'll leave this
> as it is and I think we really need to add a chapter to the
> documentation guidelines for Processing (I'll do that).
>
> Thanks
>
> Matteo



-- 
Alexander Bruy
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[matteo]

> If I'm not wrong you already asked about it and Nyall had implemented this

yes that's right, but with was for groups and not single algorithm
names. With your fix of some hour ago the link of native algorithm looks
like:

https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#nativepackage

and not

https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#qgispackage

but that's alright. I'm changing the names manually. So I'll leave this
as it is and I think we really need to add a chapter to the
documentation guidelines for Processing (I'll do that).

Thanks

Matteo
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[Alexander Bruy]

If I'm not wrong you already asked about it and Nyall had implemented this

2018-02-24 17:26 GMT+02:00 matteo :
>> Here we go.
>> https://github.com/qgis/QGIS/commit/598b8a9c41e3788962778039adcc30f2912d822f
>> Currently only for master, not sure if it is safe to push to
>> release-3_0 right now.
>> Will backport it a bit later.
>>
>> Help link now looks like
>> https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#qgisidwinterpolation
>>
>> Hope this solves your issues.
>
> thanks Alex, I'm testing it and it looks great.
>
> I saw a small drawback when the provider is `native` and not `qgis`. For
> the moment I'll change all the anchors to the correct provider (e.g.
> `nativepackage`, `qgisimporttospatialite`). Do you think that it would
> be smart to rename native to qgis automatically?
>
> Cheers
>
> Matteo



-- 
Alexander Bruy
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[matteo]

> Here we go.
> https://github.com/qgis/QGIS/commit/598b8a9c41e3788962778039adcc30f2912d822f
> Currently only for master, not sure if it is safe to push to
> release-3_0 right now.
> Will backport it a bit later.
> 
> Help link now looks like
> https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#qgisidwinterpolation
> 
> Hope this solves your issues.

thanks Alex, I'm testing it and it looks great.

I saw a small drawback when the provider is `native` and not `qgis`. For
the moment I'll change all the anchors to the correct provider (e.g.
`nativepackage`, `qgisimporttospatialite`). Do you think that it would
be smart to rename native to qgis automatically?

Cheers

Matteo
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[Alexander Bruy]

Here we go.
https://github.com/qgis/QGIS/commit/598b8a9c41e3788962778039adcc30f2912d822f
Currently only for master, not sure if it is safe to push to
release-3_0 right now.
Will backport it a bit later.

Help link now looks like
https://docs.qgis.org/3.1/uk/docs/user_manual/processing_algs/qgis/interpolation.html#qgisidwinterpolation

Hope this solves your issues.

2018-02-24 13:35 GMT+02:00 matteo :
>> Ok, it is clear now. Should I commit this change to release-3_0 and
>> master branches
>> right now?
>
> yes please! would be great to have for the 3.0.1!
>
> I found also another small small issue with just the GDAL Help button
> and I reported it here:
>
> https://issues.qgis.org/issues/18198#change-87424
>
> it might be a really small issue.
>
>
> Many thanks Alex
>
> Cheers
>
> Matteo



-- 
Alexander Bruy
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[matteo]

> Ok, it is clear now. Should I commit this change to release-3_0 and
> master branches
> right now?

yes please! would be great to have for the 3.0.1!

I found also another small small issue with just the GDAL Help button
and I reported it here:

https://issues.qgis.org/issues/18198#change-87424

it might be a really small issue.


Many thanks Alex

Cheers

Matteo
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[Alexander Bruy]

Ok, it is clear now. Should I commit this change to release-3_0 and
master branches
right now?

2018-02-24 13:25 GMT+02:00 matteo :
> Hi Alex,
>
>
>> well, previously it worked in the exactly this way, link was created
>> using algorithm id which eventually is a concatenation of the provider
>> name and algorithm name. But on requrest from documentation team
>> this behaviour was changed to current approach.
>>
>> So now you want to go back to links like this
>>
>> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vectoroverlay.html#qgisintersection
>>
>> Is this correct? Just want to clarify before implemeting it to avoid yet 
>> another
>> round of discussions and "fixing".
>
> according with Richard, we think that having the link
>
> https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vectoroverlay.html#qgisintersection
>
> so provider name concatenated with algorithm name is the way to go. To
> avoid any other future issues with hyphens vs underscores etc I think it
> is smart to have a single string like `qgiscountpointsinpolygon` instead
> of `qgis_countpointsinpolygon`.
>
> This way the name of the algorithm should be always unique even among
> providers.
>
> I'm sorry that we did not face these issues before, but nobody thought
> we can have this sphinx troubles with anchors.
>
>
> Thanks Alex for taking care of this
>
> Cheers
>
> Matteo



-- 
Alexander Bruy
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer

Re: [QGIS-Developer] Processing doc - sphinx - anchors

[Alexander Bruy]

Hi Matteo,

well, previously it worked in the exactly this way, link was created
using algorithm id which eventually is a concatenation of the provider
name and algorithm name. But on requrest from documentation team
this behaviour was changed to current approach.

So now you want to go back to links like this

https://docs.qgis.org/testing/en/docs/user_manual/processing_algs/qgis/vectoroverlay.html#qgisintersection

Is this correct? Just want to clarify before implemeting it to avoid yet another
round of discussions and "fixing".

2018-02-24 12:46 GMT+02:00 matteo :
> Hi devs,
>
> for those of you that followed the discussion you know we have some
> issues with the sphinx anchors and the name of the algorithms in the
> code if the name of the algorithm has more than one word (e.g. count
> point in polygon)
>
> We were able to manage it by putting an anchor with the exact name of
> the algorithm (e.g. `.. _countpointsinpolygon): this creates a span tag
> in the html that behaves like an anchor.
>
> Future issues will appear if we have the same anchor name for different
> algorithm, e.g. slope of GDAL and slope of QGIS. Sphinx does not accept
> 2 anchor with the same name, even if in different files.
>
> One proposal would be to change the name of the algorithm in the code
> and put the name of the provider before the name of the algorithm:
>
> `gdalslope` vs `qgisslope`
>
> then we are sure to have unique algorithm names.
>
> Feedback are very welcome, but I think this should be fixed (of course
> also in other way, maybe sphinx side?)
>
> Cheers
>
> Matteo
> ___
> QGIS-Developer mailing list
> QGIS-Developer@lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer



-- 
Alexander Bruy
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer