search

executablebooks / sphinx-jupyterbook-latex

Supporting LaTeX infrastructure for Jupyter Book
https://sphinx-jupyterbook-latex.readthedocs.io
BSD 3-Clause "New" or "Revised" License
29 stars 13 forks source link

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

Open mmcky opened 3 years ago

mmcky commented 3 years ago

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

mmcky commented 2 years ago

@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.