#415: API-alphabetical from md to rst

[antoinemeyer5]

Notes

• This PR is part of Ensure that the documentation builds warning free when testing PRs #378
• I have tested all the links.
• The file is identical to the original.

Screenshots

[fnrizzi]

ine 12 and line 14: These are exactly the same lines. I have to remove the duplication, isn't it

yes

[fnrizzi]

please make sure ALL links are correct - I will make a pass too, but just want to make sure you do that too

[crtrott]

I don't think we can do the Subview thing this way. Otherwise looks good.

[fnrizzi]

@antoinemeyer5 can you please describe the solution so that it is clear what is going on

[antoinemeyer5]

There are two ways to create internal links with rst:

(1) simple link: `Subview <core/view/Subview_type.html>`_

The first solution (1) is simple, but makes no difference between the link name and its display. Internally, the link is called Subview and the display clickable by the user is Subview. In our case, there were several links with the same internal name, so we had a duplication warning.

(2) more customizable link:

.. declaration
.. |SubviewType| replace:: Subview
.. _SubviewType: core/view/Subview_type.html

.. use
|SubviewType|_

This second solution (2) does the same thing and display, but differentiates between:

• the internal name of the link (here SubviewType),
• the display of the link to the user (here Subview) and
• the destination of the link.

Thanks to this, you can converse with the desired display and avoid internal duplication. You must always be careful not to have another link in this file whose name is SubviewType, otherwise the duplication warning will return.

With this solution, it's much simpler to have internal link names with a certain shape and a different display. This separates rst's internal logic from the user's display.

[fnrizzi]

ok makes sense to me

[nmm0]

BTW - In the future, we could potentially rely on the index since it's auto-generated

[fnrizzi]

BTW - In the future, we could potentially rely on the index since it's auto-generated

sounds a good idea