[Bug web/107650] New: Sphinx generated web pages don't have up (to the section index)

[Bug web/107650] New: Sphinx generated web pages don't have up (to the section index)

[pinskia at gcc dot gnu.org]

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

            Bug ID: 107650
           Summary: Sphinx generated web pages don't have up (to the
                    section index)
           Product: gcc
           Version: 13.0
            Status: UNCONFIRMED
          Keywords: documentation
          Severity: normal
          Priority: P3
         Component: web
          Assignee: unassigned at gcc dot gnu.org
          Reporter: pinskia at gcc dot gnu.org
  Target Milestone: ---

The texinfo generated HTML has an up link which links to the section that the
page is linked from.
While the Sphinx generated HTML does not.
An example for texinfo is
https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/eBPF-Options.html#eBPF-Options
compared to
https://gcc.gnu.org/onlinedocs/gcc/gcc-command-options/machine-dependent-options/ebpf-options.html
.

Is there a way to get this feature back? as it is useful when browsing the
manual.

The other thing that would be a nice feature back is having next/previous/up
links at the start also and not just at the end of the page.

The order of previous and next on the bottom of the page is ok even though it
is swapped from what it was previously.

[Bug web/107650] Sphinx generated web pages don't have up (to the section index)

[pinskia at gcc dot gnu.org]

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

--- Comment #1 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
The side bar has issues with the text being so much bigger and popping out
compared to the main text. Plus when I scroll it, the search and icon part just
takes up so much of it, the side bar becomes not very useful.

[Bug web/107650] Sphinx generated web pages don't have "up" (to the section TOC)

[pinskia at gcc dot gnu.org]

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

--- Comment #2 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
Index is different from TOC. The up should goto the section TOC and not the
index of the section.

[Bug web/107650] Sphinx generated web pages don't have "up" (to the section TOC)

[marxin at gcc dot gnu.org]

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

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

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

--- Comment #3 from Martin Liška <marxin at gcc dot gnu.org> ---
(In reply to Andrew Pinski from comment #0)
> The texinfo generated HTML has an up link which links to the section that
> the page is linked from.
> While the Sphinx generated HTML does not.
> An example for texinfo is
> https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/eBPF-Options.html#eBPF-Options
> compared to
> https://gcc.gnu.org/onlinedocs/gcc/gcc-command-options/machine-dependent-
> options/ebpf-options.html .
> 
> Is there a way to get this feature back? as it is useful when browsing the
> manual.

No, I don't think it was useful as one was missing complete navigation that is
right now on the left.

> 
> The other thing that would be a nice feature back is having next/previous/up
> links at the start also and not just at the end of the page.
> 
> The order of previous and next on the bottom of the page is ok even though
> it is swapped from what it was previously.

The layout is better in Sphinx as it corresponds to expect layout (similarly to
web browsers).

[Bug web/107650] Sphinx generated web pages don't have "up" (to the section TOC)

[pinskia at gcc dot gnu.org]

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

--- Comment #4 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
(In reply to Martin Liška from comment #3)
> (In reply to Andrew Pinski from comment #0)
> > The texinfo generated HTML has an up link which links to the section that
> > the page is linked from.
> > While the Sphinx generated HTML does not.
> > An example for texinfo is
> > https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/eBPF-Options.html#eBPF-Options
> > compared to
> > https://gcc.gnu.org/onlinedocs/gcc/gcc-command-options/machine-dependent-
> > options/ebpf-options.html .
> > 
> > Is there a way to get this feature back? as it is useful when browsing the
> > manual.
> 
> No, I don't think it was useful as one was missing complete navigation that
> is right now on the left.

Except the navigation does not fully replace the up button.
An example is if you scroll down on the top level TOC down to the "Nios II
Options" (not on the navigation on the left) and click it. The navigation on
the left does not scroll down to the same location. Making it harder to figure
out where you are.

> 
> > 
> > The other thing that would be a nice feature back is having next/previous/up
> > links at the start also and not just at the end of the page.
> > 
> > The order of previous and next on the bottom of the page is ok even though
> > it is swapped from what it was previously.
> 
> The layout is better in Sphinx as it corresponds to expect layout (similarly
> to web browsers).

So that is broken. Having it on the top and the bottom is still useful. Maybe
you clicked the wrong link but it was the next one you either have to use the
left/right links at the buttom or you have to understand the left/right curser
keys are bound to previous/next page. Again still confusing. Most web UI
designers have ignored UI design for years how humans work and just make broken
things we should not repeat the same mistakes.

[Bug web/107650] Sphinx generated web pages don't have "up" (to the section TOC)

[marxin at gcc dot gnu.org]

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

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

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

--- Comment #5 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.