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

Is the "and tables" in "Indices and tables" still relevant? #10972

Open
jfbu opened this issue Nov 14, 2022 · 0 comments
Open

Is the "and tables" in "Indices and tables" still relevant? #10972

jfbu opened this issue Nov 14, 2022 · 0 comments

Comments

@jfbu
Copy link
Contributor

jfbu commented Nov 14, 2022

Describe the bug

Due to some discussion on translation into French I did some archaeology regarding the "Indices and tables" from file https://github.com/sphinx-doc/sphinx/blob/master/sphinx/templates/quickstart/root_doc.rst_t and find in commit d60ca8d in HTML template named sphinx/templates/index.html, here is the relevant html part:

  <p><strong>Indices and tables:</strong></p>
  <table class="contentstable" align="center"><tr>
    <td width="50%">
      <p class="biglink"><a class="biglink" href="{{ pathto("modindex.rst") }}">Global Module Index</a><br>
         <span class="linkdescr">quick access to all modules</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("genindex.rst") }}">General Index</a><br>
         <span class="linkdescr">all functions, classes, terms</span></p>
    </td><td width="50%">
      <p class="biglink"><a class="biglink" href="{{ pathto("search.rst") }}">Search page</a><br>
         <span class="linkdescr">search this documentation</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("contents.rst") }}">Complete Table of Contents</a><br>
         <span class="linkdescr">lists all sections and subsections</span></p>
    </td></tr>
  </table>

From this it looks as if the and tables referred to the table of contents. However things are now handled otherwise and the sphinx-quickstart root_doc.rst_t template proposes

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Should we keep the "and tables" part?

How to Reproduce

any new project

Environment Information

not relevant

Sphinx extensions

No response

Additional context

No response

@AA-Turner AA-Turner added this to the some future version milestone Apr 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants