Make emojis in titles not cause: WARNING: headline too short

[legendenomgeorg]

If i make a title in a .ipynb file like "# Description of currently available functions📖", I get a warning when building the documentation using sphinx-build:

Description of currently available functions📖
=============================================
C:\path\Functions.ipynb:45: WARNING: Title underline too short.

I could of course supress all warnings, but i do not want to do that, since my supervisor deems some of the warnings too import to not fail our CI-setup. I've tried to supress the specific warning in sphinx, but it seems to be impossible, as the warning stems from docutils, and not sphinx.

I think the problem is, that nbsphinx does not regard the emoji in the title as a character, and therefore creates a too short underline, when converting the notebook to a .rst file.

Note: The documentation gets built succesfully and the emojis are present in the titles.

[mgeier]

Thanks for reporting this!

I think this is related to the external pandoc software which is currently (until #36) used to convert Markdown to reStructuredText.

Your example headline works for me without warning.

Which version of pandoc are you using? Maybe you can upgrade?

$ pandoc --version
pandoc 2.17.1.1

You can also try the behavior by pasting the headline into a terminal:

$ pandoc -f markdown -t rst
# Description of currently available functions📖
<press Ctrl-D>
Description of currently available functions📖
==============================================