search

executablebooks / sphinx-multitoc-numbering

A Sphinx extension to support continuous numbering of sections across multiple tocs in HTML output.
https://sphinx-multitoc-numbering.readthedocs.io/en/latest
MIT License
14 stars 3 forks source link

`_toc.yml` example in docs is incompatible #25

Open michaelosthege opened 2 years ago

michaelosthege commented 2 years ago

Describe the bug

@AakashGfude

I'm trying to understand how to use sphinx-multitoc-numbering with Jupyter book, but the _toc.yml example in the documentation uses an outdated format.

I tried different variations but none of them render.

Reproduce the bug

Take the example from the docs & paste it into a _toc.yml.

Attempting to build gives The Table of Contents file is malformed: toc is not a mapping: <class 'list'>

List your environment

Jupyter Book      : 0.12.2
External ToC      : 0.2.3
MyST-Parser       : 0.15.2
MyST-NB           : 0.13.1
Sphinx Book Theme : 0.1.10
Jupyter-Cache     : 0.4.3
NbClient          : 0.5.13
welcome[bot] commented 2 years 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: