Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Enable support for format in _toc.yml #80

Open
1 task
mmcky opened this issue Oct 11, 2021 · 1 comment
Open
1 task

ENH: Enable support for format in _toc.yml #80

mmcky opened this issue Oct 11, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@mmcky
Copy link
Member

mmcky commented Oct 11, 2021

Description / Summary

We should explicitly link the format types that are defined in _toc.yml to the operation of this extension and ensure support for jb-article and jb-book.

Documentation for the latest format definitions are available here:

https://jupyterbook.org/customize/toc.html#

and definitions are here:

https://sphinx-external-toc.readthedocs.io/en/latest/user_guide/sphinx.html#using-different-key-mappings

We have tested against jb-book primarily so we should do additional testing for jb-article

Value / benefit

This will tie in nicely with the available metadata now available through the format key in _toc.yml to enable more targeted assumptions in the LaTeX translation. If we know the jb-article key is provided we can make more assumptions about the document structure when parsing the sphinx.ast.

Implementation details

TBD

Tasks to complete

  • review the best way to add jb-article and jb-book
@mmcky mmcky added the enhancement New feature or request label Oct 11, 2021
@mmcky
Copy link
Member Author

mmcky commented Apr 1, 2022

@AakashGfude this is the issue I put together to start thinking about how we can tailor this extension to use the metadata contained in _toc.yml to make tighter and more accurate assumptions etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant