-
Notifications
You must be signed in to change notification settings - Fork 325
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
Empty TOC in right sidebar #854
Comments
Can somebody please provide a minimal reproducible example or link? I worry that this won't get fixed if debugging requires building the entire scipy docs... |
I've put in a PR to MNE-Python that should generate a working CircleCI site that demos this error. Will update here once the build is done. |
Here is the rendered MNE-Python doc with the empty right column: |
Diagnosis of what's going wrongOK looking at the docs that @drammock shared, I think that this is the problem:
What we can do to improve thisShort-term fixFirst off, I think that @drammock and @tupui can solve their problem by defining: html_theme_options = {
...
"secondary_sidebar_items": ["page-toc"],
...
} This should remove those empty Long-term fixUltimately, I think the behavior that we would want is:
If somebody wants to give a shot at the long-term fix, I'm happy to review! |
I will try the work around tomorrow thanks! |
I can confirm that it does fix the issue (and does not seem to have unwanted side effect for me), thanks! 😃 |
agreed that this does fix things for MNE-Python docs too. I'll see if I can figure out the long-term fix. |
Also since there's a very easy workaround (just one line change to |
Just a note that I believe this will now always be the case unless you manually remove the secondary sidebar, because the |
FYI I rebuild recently with |
@tupui can you please provide more context than this? It is hard to understand what might be going wrong without at least a link to the configuration you're using and a reproducible example. |
In the discussion we said that this was a workaround to the issue
I am saying that it's not the case anymore. Compiling SciPy (cf the PR I linked in the description) still leads to the issue. Maybe @drammock can confirm using the same example he had? Sorry I don't have more time to put into investigating doc issues at the moment. And tbh, I don't have the skills as I know close to nothing about internals of Sphinx. So it could take me unreasonable time to track down something. |
I suspect that you've since upgraded to a newer version of this theme. The configuration value is now |
Yes I do have that, sorry for not updating the code e.g. |
I think that this PR will fix the issue: |
Great, thank you for having a look! Happy to test this when you want. |
When the TOC is empty, the right sidebar is still present through
bd-sidebar-secondary bd-toc
This is observed in SciPy. To build SciPy and the doc (build should take around 3 mins with 6 cores, then 5 mins for the doc itself):
The text was updated successfully, but these errors were encountered: