Should the genindex be in the TOC? about dronekit-python HOT 5 CLOSED

Probably below API reference? do you find it useful?

from dronekit-python.

Not "super" useful - and this will be less useful when our class documentation CSS is improved and it is possible to read it more easily.

If we do want this in the TOC it has to be added as an explicit URL link to the index as shown below (ie you can't link to the version just built!):

Index <http://python.dronekit.io/genindex.html>

We could however just add it as a link on a home page or similar and then it can be linked "properly" using :ref:genindex.

I propose we do not add this. If neither of us are convinced it has clear value, then probably it is just clutter?

from dronekit-python.

If you can add it as a submenu item of the api reference I vote to add it, if not lets leave it out

from dronekit-python.

I can, included in pull request #58

Note, the included doc is hardcoded to point to the current python version of the file - so if you build this locally the link will take you to the main site. This is not desirable, but there is no way around it (as discussed above - you cannot include genindex in a TOC except by providing a full URL).

Closing, as this will be delivered by the pull request

from dronekit-python.

thanks @hamishwillee

from dronekit-python.