question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add home page to the TOC / left menu ?

See original GitHub issue

Is your feature request related to a problem? Please describe. The home page of my jupyter book doesn’t show up in the left toc/menubar, so the only way to access it is to click on the logo (which is not intuitive).

A good workaround would be to permit the same file to appear twice in the _toc.yml, but when I add the file again, I get this error message:

...physics111-course/about/syllabus.md: WARNING: circular toctree references detected, ignoring: about/syllabus <- about/syllabus

Here’s the structure of the toc file that generated the above error:

- file: about/syllabus

- part: About this Course
  chapters:
    - file: about/syllabus
    - file: about/course_schedule
    - file: about/accommodations
    - file: about/doing_well
    - file: about/faq

Describe the solution you’d like Two suggestions:

  1. Add the homepage to the toc structure (the downside of this solution is that if you want the home page to be within a part heading, that will have to be configured separately).

  2. Allow repeating of the home page in the _toc structure file.

Describe alternatives you’ve considered

I’ve thought about restructuring my book to avoid this by having a splash page, but it’s an extra click for the users and feels like a bad solution.

Additional context

Since we’re talking about the toc files so much in recent issues and PRs.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
choldgrafcommented, Aug 5, 2020

Ah I think we should close that - I don’t believe that it is possible given the way that Sphinx thinks about site structure. Sphinx considers the “first page” as a landing page that is different from the rest of the book structure, which is why we can’t nest things underneath it (the thing that’s nested underneath it are all of the top-level chapters of the book)

Thanks for documenting this though!

0reactions
quantitative-technologiescommented, Sep 6, 2022

See he home_page_in_navbar section here: https://jupyterbook.org/customize/config.html if that works for you, wanna add a quick documentation PR for it? We should document that!

This had no effect for me. And how do we specify the homepage url?

This was being caused by the sphinx.config.html_theme_options settings being given:

sphinx:
  config:
    html_theme_options:
      use_download_button: false
Read more comments on GitHub >

github_iconTop Results From Across the Web

Create a table of contents in Pages on Mac - Apple Support
Add a TOC for the whole document: Click the Insert Table of Contents button at the bottom of the Table of Contents sidebar....
Read more >
toctree - How do I include the homepage in the Sphinx TOC?
I want my template to include a sidebar that lists all 3 top-level pages (homepage, installation, templating/index). I've tried adding a second, ...
Read more >
Insert a table of contents - Microsoft Support
For each heading that you want in the table of contents, select the heading text. · Go to Home > Styles, and then...
Read more >
How To: Create a Clickable Table of Contents (TOC)
First page should be a blank page to insert Table of Content ... Under Styles at the top (when you are on the...
Read more >
Is there a way to add a Page navigation tree (base...
Basically, I have a very large document (page) and instead of displaying its table of contents at the top of the page, I...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found