Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

link bahaviour on subsections #838

Open
pvgenuchten opened this issue Aug 23, 2023 · 3 comments
Open

link bahaviour on subsections #838

pvgenuchten opened this issue Aug 23, 2023 · 3 comments

Comments

@pvgenuchten
Copy link

pvgenuchten commented Aug 23, 2023

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.

@jmckenna
Copy link
Member

@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.

@geographika
Copy link
Member

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 sphinx-doc/sphinx#7087 and then added to the MapServer docs in #324 to get fixed URLs for all indexed items.
The first link I think is default behaviour in Sphinx when using a TOC.

@pvgenuchten
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants