Add home page to the TOC / left menu ?
See original GitHub issueIs 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:
-
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). -
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:
- Created 3 years ago
- Comments:6 (4 by maintainers)
Top GitHub Comments
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!
This was being caused by the
sphinx.config.html_theme_options
settings being given: