executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
429 stars 198 forks source link

headers in markdown dont appear as collapsible menu on left sidebar #735

Open armando-fandango opened 1 year ago

armando-fandango commented 1 year ago

Describe the bug

context I added level 1,2,3 headers to the Markdown and included it in the index.rst.

conf.py:

html_theme_options = {
    "show_navbar_depth": 3,
    "navigation_depth": 3,
    "show_nav_level": 3,
    "show_toc_level": 3,
...

expectation I expected left side bar to have 3 levels of navigation items in a collapsible menu.

bug But instead only level 1 headers appear. Level 2 and 3 headers are not appearing at all in the left side bar.

$ jupyter-book build mybook
ERROR ...

problem This is a problem for people building the docs from markdown and expecting headers to show up on the left bar.

Reproduce the bug

Use an markdown file and try creating the left side bar with 2-3 level of headers from markdown. Not from toctree declarator.

List your environment

No response

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

eudoxos commented 7 months ago

This is (likely) related to #614