Giter VIP home page Giter VIP logo

tomhodson / ipython Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ipython/ipython

0.0 2.0 0.0 75 MB

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

Home Page: https://ipython.readthedocs.org

License: BSD 3-Clause "New" or "Revised" License

Shell 0.37% Python 69.94% Makefile 0.14% Batchfile 0.01% Jupyter Notebook 29.53%

ipython's Introduction

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]'

ipython's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.