[Bug web/107643] New: [13 Regression] sphix generated indexes are not working at all

[Bug web/107643] New: [13 Regression] sphix generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

            Bug ID: 107643
           Summary: [13 Regression] sphix generated indexes are not
                    working at all
           Product: gcc
           Version: 13.0
            Status: UNCONFIRMED
          Keywords: documentation
          Severity: blocker
          Priority: P3
         Component: web
          Assignee: unassigned at gcc dot gnu.org
          Reporter: pinskia at gcc dot gnu.org
  Target Milestone: ---

https://gcc.gnu.org/onlinedocs/gccint/indices-and-tables.html
https://gcc.gnu.org/onlinedocs/gcc/indices-and-tables.html

All say TODO

[Bug web/107643] [13 Regression] sphix generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Andrew Pinski <pinskia at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
   Target Milestone|---                         |13.0

[Bug web/107643] [13 Regression] sphix generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

--- Comment #1 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
I had used these to find the options and other keywords for GCC 12 manual all
the time. Because searching to find the right page is hard. Especially if it is
2 layers down.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |marxin at gcc dot gnu.org

--- Comment #2 from Martin Liška <marxin at gcc dot gnu.org> ---
Created attachment 53892
  --> https://gcc.gnu.org/bugzilla/attachment.cgi?id=53892&action=edit
Screenshot

There's a screenshot that should link to Index where you have the expected
listing.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

--- Comment #3 from Martin Liška <marxin at gcc dot gnu.org> ---
The preferred way of searching is using the Search text input on the left. It
works very well.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |RESOLVED
         Resolution|---                         |INVALID

--- Comment #4 from Martin Liška <marxin at gcc dot gnu.org> ---
Invalid.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Andrew Pinski <pinskia at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |UNCONFIRMED
         Resolution|INVALID                     |---

--- Comment #5 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
How is this invalid when the docs still say todo on them?

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

--- Comment #6 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
(In reply to Martin Liška from comment #3)
> The preferred way of searching is using the Search text input on the left.
> It works very well.

Expect if you don't know the name of an option reading the index is important.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |ASSIGNED
   Last reconfirmed|                            |2022-11-13
     Ever confirmed|0                           |1
           Assignee|unassigned at gcc dot gnu.org      |marxin at gcc dot gnu.org

--- Comment #7 from Martin Liška <marxin at gcc dot gnu.org> ---
(In reply to Andrew Pinski from comment #5)
> How is this invalid when the docs still say todo on them?

Oh, this one. The 'TODO' refers to todolist extension which lists all todos in
the documentation and is excluded in the non-development version of the
documentation.
Anyway, I'm going to remove it.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

--- Comment #8 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Martin Liska <marxin@gcc.gnu.org>:

https://gcc.gnu.org/g:c64fd69420fd153f9fb16a603ff0a711fbde8335

commit r13-3942-gc64fd69420fd153f9fb16a603ff0a711fbde8335
Author: Martin Liska <mliska@suse.cz>
Date:   Sun Nov 13 15:16:12 2022 +0100

    sphinx: include todolist only if INCLUDE_TODO env. set

    It is confusing that 'Indexes and tables' contains TODO. One gets
    Index by clicking to the Index link.

            PR web/107643

    ChangeLog:

            * doc/baseconf.py: Set include_todo tag if INCLUDE_TODO env
            is set.
            * doc/indices-and-tables.rst: Use include_todo tag.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |RESOLVED
         Resolution|---                         |FIXED

--- Comment #9 from Martin Liška <marxin at gcc dot gnu.org> ---
Closing now.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Andrew Pinski <pinskia at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |NEW
         Resolution|FIXED                       |---

--- Comment #10 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
Still not fixed.
The "Indexes and tables" page still does NOT link the index.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

--- Comment #11 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
(In reply to CVS Commits from comment #8)

>     It is confusing that 'Indexes and tables' contains TODO. One gets
>     Index by clicking to the Index link.

I don't see an Index link. There is no link to the top TOC anywhere either.

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

--- Comment #12 from Martin Liška <marxin at gcc dot gnu.org> ---
(In reply to Andrew Pinski from comment #11)
> (In reply to CVS Commits from comment #8)
> 
> >     It is confusing that 'Indexes and tables' contains TODO. One gets
> >     Index by clicking to the Index link.
> 
> I don't see an Index link. There is no link to the top TOC anywhere either.

Can you see the mouse pointer on the screenshot? It points to a hyperlink
called Index. What's still missing?

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

--- Comment #13 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
(In reply to Martin Liška from comment #12)
> (In reply to Andrew Pinski from comment #11)
> > (In reply to CVS Commits from comment #8)
> > 
> > >     It is confusing that 'Indexes and tables' contains TODO. One gets
> > >     Index by clicking to the Index link.
> > 
> > I don't see an Index link. There is no link to the top TOC anywhere either.
> 
> Can you see the mouse pointer on the screenshot? It points to a hyperlink
> called Index. What's still missing?

It is so little compared to anything else on the screen, it can't be seen. And
why not a direct link from the TOC?

[Bug web/107643] [13 Regression] sphinx generated indexes are not working at all

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |ASSIGNED

--- Comment #14 from Martin Liška <marxin at gcc dot gnu.org> ---
Ok, so it's possible with a small workaround:
https://stackoverflow.com/questions/36235578/how-can-i-include-the-genindex-in-a-sphinx-toc

[Bug web/107643] [13 Regression] sphinx Index should be added to the top-level TOC

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107643

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |RESOLVED
         Resolution|---                         |WONTFIX

--- Comment #15 from Martin Liška <marxin at gcc dot gnu.org> ---
The Sphinx documentation has been reverted:
https://gcc.gnu.org/pipermail/gcc/2022-November/239983.html

Thus, I'm closing this as won't fix.