##// END OF EJS Templates
Make set_next_input work with older versions of prompt_toolkit
Thomas Kluyver -
r23292:459ecdd3
Show More
Name Size Modified Last Commit Author
/ docs
man
source
sphinxext
Makefile 4.6 KiB
r22915:3f124e79ce8e
Thomas Kluyver
README.rst 1.1 KiB
r22667:a89c3c992bb3
Matthias Bussonnier
autogen_api.py 3.6 KiB
r22769:c17ff28cb122
Min RK
autogen_config.py 1.0 KiB
r22615:3d83950a1ea6
Thomas Kluyver
autogen_magics.py 1.9 KiB
r21590:1b9c89e1df83
Min RK
autogen_shortcuts.py 2.4 KiB
r23231:5835a76e1eb6
Srinivas Reddy Thatiparthy
make.cmd 2.6 KiB
r22590:c64b5204c31c
klonuo
requirements.txt 32 B
r22635:b0683fdae24c
Matthias Bussonnier

IPython Documentation

This directory contains the majority of the documentation for IPython.

Deploy docs

Documentation is automatically deployed on ReadTheDocs on every push or merged Pull requests.

Requirements

The following tools are needed to build the documentation:

  • sphinx

On Debian-based systems, you should be able to run:

sudo apt-get install python-sphinx

The documentation gets built using make, and comes in several flavors.

make html - build the API and narrative documentation web pages, this is the default make target, so running just make is equivalent to make html.

make html_noapi - same as above, but without running the auto-generated API docs. When you are working on the narrative documentation, the most time consuming portion of the build process is the processing and rending of the API documentation. This build target skips that.

make pdf will compile a pdf from the documentation.

You can run make help to see information on all possible make targets.