jupyter-book icon indicating copy to clipboard operation
jupyter-book copied to clipboard

Some documentated MyST options are ignored

Open alcrene opened this issue 2 years ago • 3 comments

As far as I can tell, a number of documented options MyST parser are actually ignored by Jupyter Book's config file parser. I noticed this for the following two:

  • myst_linkify_fuzzy_links
  • myst_dmath_double_inline

but I suspect the problem is more generalized. The last one is even set to True in the default config file, but when checking the compilation output, one sees that all builds actually use False.

The problem seems to be that those options are never read by config.py: https://github.com/executablebooks/jupyter-book/blob/1ee1a88468ef3616c24e64577c2ce332000807f7/jupyter_book/config.py#L339-L342 When I add "myst_dmath_double_inline" to the list on line 340, then inlined display equations are recognized as expected.

alcrene avatar May 31 '22 22:05 alcrene

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:

welcome[bot] avatar May 31 '22 22:05 welcome[bot]

@alcrene Did you identify a workaround? Same issue here

adelavega avatar Jul 29 '22 17:07 adelavega

@adelavega I don't know of a simpler workaround than forking the repo and making the tiny one line change I outlined above. If you don't need to worry about users, I would consider that a viable temporary solution.

alcrene avatar Aug 07 '22 19:08 alcrene

thanks for reporting this @alcrene. Sorry for the delays in getting back to this. It sounds like after https://github.com/executablebooks/jupyter-book/pull/1842 is released we need to harmonise some of the myst options that are available in the top level Jupyter-book cli.

mmcky avatar Nov 09 '22 04:11 mmcky

I also ran into this. The proposed solution works for me.

pjbruin avatar Jul 17 '23 08:07 pjbruin