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

Admonitions in docstring are not rendered correctly #585

Open
BenjaminBorn opened this issue Sep 12, 2017 · 4 comments
Open

Admonitions in docstring are not rendered correctly #585

BenjaminBorn opened this issue Sep 12, 2017 · 4 comments

Comments

@BenjaminBorn
Copy link

BenjaminBorn commented Sep 12, 2017

Admonitions in a docstring like !!! note don't seem to be rendered in the Jupyter Notebook (see screen shot)

screenshot 2017-09-12 14 18 30

In the REPL and Juno, this example is rendered correctly.

My system:

Julia Version 0.6.0
Commit 903644385b (2017-06-19 13:05 UTC)
Platform Info:
OS: macOS (x86_64-apple-darwin16.6.0)
CPU: Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz
WORD_SIZE: 64
BLAS: libopenblas (USE64BITINT DYNAMIC_ARCH NO_AFFINITY Haswell)
LAPACK: libopenblas64_
LIBM: libopenlibm
LLVM: libLLVM-3.9.1 (ORCJIT, skylake)

@stevengj
Copy link
Member

It looks like Jupyter's Markdown renderer doesn't support !!! admonitions. If you enter the same thing in a markdown cell in the notebook it also doesn't work for me.

I think the root problem here is that !!! doesn't seem to be standard Markdown; it seems Julia-specific.

@BenjaminBorn
Copy link
Author

Ok, thanks for the quick reply. Is there any way we could adapt the standard Markdown of the notebook to Julia idiosyncrasies?

@stevengj
Copy link
Member

Base.Markdown could be upgraded to support better conversion to other MIME types, I guess.

@stevengj
Copy link
Member

See also jupyter/notebook#1292 … it doesn't seem like admonition support is coming to Jupyter any time soon 😢.

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

No branches or pull requests

2 participants