Skip to content

ipython-contrib/ipython-markdown-inspector

Repository files navigation

ipython-markdown-inspector

tests CodeQL Binder pypi-version

IPython extension providing inspection results as Markdown, enabling better integration with Jupyter Notebook and JupyterLab. Depends on docstring-to-markdown.

Installation

Requires IPython 8.22 or newer (which requires Python 3.10 or newer).

pip install ipython-markdown-inspector

Usage

To load an extension while IPython is running, use the %load_ext magic:

%load_ext ipython_markdown_inspector

To load it each time IPython starts, list it in your configuration file:

c.InteractiveShellApp.extensions = [
    'ipython_markdown_inspector'
]

After enabling the extension, both the contents of "Contextual Help" panel, and results of info requests such as %run? or df? will provide the output in Markdown format.