MapServer-documentation icon indicating copy to clipboard operation
MapServer-documentation copied to clipboard

link bahaviour on subsections

Open pvgenuchten opened this issue 2 years ago • 3 comments

I noticed at various locations in docs this convention:

.. index::
   pair: Apache; ReWriteRule

Apache ReWrite rules (using Apache mod_rewrite)
-----------------------------------------------

With current setup this is encoded in html as:

<h3>
<a class="toc-backref" href="#table-of-contents" role="doc-backlink">Apache ReWrite rules (using Apache mod_rewrite)</a>
<a class="headerlink" href="#apache-rewrite-rules-using-apache-mod-rewrite" title="Link to this heading">¶</a>
</h3>

It is a convention i'm not familiar with, even unexpected. In stead I would expect a single link to the current item (to be able copy/paste it) and if desirable an extra to-top link which brings the user back to the TOC.

pvgenuchten avatar Aug 23 '23 08:08 pvgenuchten

@pvgenuchten I'm not quite understanding. Sphinx's index directive is used to define the terms in the index, nothing to do with a TOC.

jmckenna avatar Jan 16 '25 19:01 jmckenna

From what I remember, previously none of these indexed items could be linked to at all. I added in a new option to Sphinx with the help of the developers there at https://github.com/sphinx-doc/sphinx/pull/7087 and then added to the MapServer docs in https://github.com/MapServer/MapServer-documentation/pull/324 to get fixed URLs for all indexed items. The first link I think is default behaviour in Sphinx when using a TOC.

geographika avatar Jan 16 '25 19:01 geographika

Let me check that Seth, I think it’ll solve this issue

pvgenuchten avatar Jan 16 '25 22:01 pvgenuchten