executablebooks / sphinx-external-toc

A sphinx extension that allows the site-map to be defined in a single YAML file
https://sphinx-external-toc.readthedocs.io
MIT License
32 stars 18 forks source link

HTML build fails when subtree starts with subtree #89

Open n8willis opened 1 year ago

n8willis commented 1 year ago

Describe the bug

context When the first entry in a subtree is another subtree, the make html build fails, with etoc complaining that the entry is not a file, glob, or url.

For example:

root: README
options:
  maxdepth: 2
subtrees:
- maxdepth: 1
  entries:
  - file: index
    title: Overview
- maxdepth: 2
  caption: Script shaping
  entries:
  - subtrees:
    - numbered: 3
      maxdepth: 2
      caption: Indic
      entries:
      - file: opentype-shaping-indic-general
        title: General model

(that's real-world start-of-external-TOC from this project, if anyone's curious.)

expectation I expected the TOC to be built as defined.

There's certainly no reason that subtrees can't be nested within other subtrees. In fact, the extension docs show that. This bug is just (or appears to be just) when a subtree is the first item in the entries. Notably,

bug

Extension error:
[etoc] entry does not contain one of {'glob', 'file', 'url'} @ '/subtrees/1/entries/0'
make: *** [Makefile:20: html] Error 2

If I'm reading the single-quoted output part there correctly, it's crashing out at the second subtree declaration, on line 12 in the example.

problem This is a problem because the structure of the information dictates where we need subtrees, and nested subtrees can not only happen, but may be vital to organizing the docs correctly.

Reproduce the bug

As quoted in the example above.

List your environment

Sphinx 5.3.0, sphinx-external-toc 0.3.1.

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: