Skip to content
forked from ipython/ipython

A tiny patch to Ipython to make it parse sphinx formated docstrings and print them nicely when you do object?

License

BSD-3-Clause, Unknown licenses found

Licenses found

BSD-3-Clause
LICENSE
Unknown
COPYING.rst
Notifications You must be signed in to change notification settings

TomHodson/ipython

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

A Tiny patch to Ipython to enable parsing of docstrings when you call Object? or %pinfo Object

When you do Object? in Jupyter or Ipython, pinfo is the name of the magic command that gets called. This fork adds a couple experimental lines of code to parse the docstring from whatever it currently is, into the NUMPYDOC format which is a bit more readable than say reStructuredText. The before and after looks like this:

A screenshot of a docstring being displayed in rST format and then in NUMPYDOC format after parsing

I will likely let this get out of sync with the upstream Ipython repo, so if you want to use this I suggest you make your own fork of the IPython repo and manually apply the 3 line patch on top. However if you do want to install this version, do

$ git clone https://github.com/TomHodson/ipython.git
$ cd ipython
$ pip install -e '.[test]'

About

A tiny patch to Ipython to make it parse sphinx formated docstrings and print them nicely when you do object?

Resources

License

BSD-3-Clause, Unknown licenses found

Licenses found

BSD-3-Clause
LICENSE
Unknown
COPYING.rst

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 70.0%
  • Jupyter Notebook 29.5%
  • Other 0.5%