Sidebar missing on version 2022.6.21

[damienrj]

Hello, on the newest version the sidebar on the right side is now showing up in the browser. Reverting to 2022.4.7 fixes the issue.

Updating furo (2022.4.7 -> 2022.6.21)

[pradyunsg]

There is not enough detail here to understand what you're seeing.

[damienrj]

It is a little harder to describe.

This image is an example of the contents sidebar that normally gets generated. Our newest builds of the doc page was missing that and looking at the differences in Poetry installs it came down to the update in furo.

[pradyunsg]

That's not enough to understand what you're seeing. Could you please share a fuller screenshot and/or a reproducer for the issue?

Mentioning your browser and other details would help as well.

[damienrj]

Sure, I will try to make a more self contained example so that I don't need to mask out content. The behavior was the same on the current Safri and Chrome.

…

On Fri, Sep 16, 2022 at 10:27 AM Pradyun Gedam ***@***.***> wrote: That's not enough to understand what you're seeing. Could you please share a fuller screenshot and/or a reproducer for the issue? Mentioning your browser and other details would help as well. — Reply to this email directly, view it on GitHub <#526 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAU2KQYG43NX7RAKXM2B3KTV6SUYTANCNFSM6AAAAAAQNYA4JI> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[damienrj]

This is now longer an issue with the current versions so it looks good now.

[damienrj]

I thought it was answered but I have been able to debug it more.

# Example
Docs
## Installation and setup
More Docs
# Test
More docs

will work, but if the first heading that isn't the title is # than the side bar doesn't render.

# Example
Docs
# Installation and setup
More Docs
# Test
More docs

# Example
With `pip install furo==2022.4.7`
# Installation and setup
More Docs
# Test
More docs

If I downgrade furo than both examples work

# Example
With `pip install furo==2022.4.7`
## Installation and setup
More Docs
# Test
More docs

[pradyunsg]

# Example
Docs
# Installation and setup
More Docs
# Test
More docs

Your heading structure is "wrong" (well, as far as Furo and Sphinx are concerned), which is why nothing is being shown. There should only be one h1 on the page, and everything else should be nested under it. The following will do the right thing:

# Example
Docs
## Installation and setup
More Docs
## Test
More docs

See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements#avoid_using_multiple_h1_elements_on_one_page for the details.

[pradyunsg]

If you did that to get those headings into the left sidebar, that's actually not a supported thing: Furo is designed (intentionally) to separate the site structure (i.e. left sidebar) from the page content (i.e. right sidebar).

[damienrj]

Yeah, that makes sense. We have not been using it for the left sidebar. I think it was less obvious before since we were using the

title
=====

And since the older version of the package was still rendering the incorrect version we didn't know so we can update our docs. Thanks