I have been playing with iPython as part of my exploration into Python. A friend tipped me off that iPython is a little more sophisticated than the standard Python interactive prompt.
One of the features of iPython is an interactive help guide for the language. It’s pretty sweet, however, on the standard Python Mac build, it doesn’t include all the documentation. This means some of the help guide is also missing parts. In order to add the HTML docs for Python 2.5, I ended up needing to compile the docs. This required me to install a few items, which are listed below.
Essentially, the docs need to be compiled as HTML from LaTeX. I had to install LaTeX for Mac, LaTeX2HTML and Darwin Ports (aka Mac Ports). This wasn’t too difficult, but I had a few missteps along the way. The directions are mostly for my own benefit, but if you find them useful or need a correction please let me know.
Goal: Create a link to the Python Docs for use with iPython.
- Install Darwin Ports
- Install LaTeX for Mac
- Intall LaTeX2HTML
- Download Python 2.5
- Copy compiled HTML docs to Standard Location
- Create env variable
PYTHONDOCSfor iPython help reference
Notes: I am running Mac OSX 10.5.4 with Python 2.5.1 and iPython 0.10. The $ is simply my prompt in Terminal.
Installing Darwin ports is very fast and easy, just visit http://darwinports.com/ and grab the latest version. Once you get it downloaded, it’s only 1.4 megs, just click and install. It’s a very quick step.
For LaTeX, you have two choices that are outlined in this guide. I chose the simple method, which results in downloading a fairly large file (1.2 gigs) but I didn’t want to spend my day debugging LaTeX install issues, after all this is to help me learning Python!
After downloading LaTeX, it’s a basic package installer. This is the version I used.
The next requirement is the LaTeX2HTML program. It converts the doc files to HTML that will be used by iPython. You can read more about it here. I found the installation instructions were not exactly what I needed. I had to add the /opt/local/bin to my Bash path in order to install LaTeX2HTML. I did this permanently by altering .bash_profile, but for the purpose of this instructions, I have done this temporarily.
# adding to Path $ PATH = $PATH:/opt/local/bin $ cd /opt/local/bin $ sudo mkdir -p portslocation/dports/latex2html/ $ cd portslocation/dports/latex2html/ # install latex2html $ sudo port install latex2html
This process takes a little while, so grab a cup of coffee while it’s installing. After it finishes, you’re all set to compile the doc files for Python. First, you need to download the entire Python package. Take a look at the releases here. Here is the specific process I followed.
$ cd ~; mkdir tmp; cd tmp $ curl -O http://www.python.org/ftp/python/2.5/Python-2.5.tgz $ tar -zxf Python-2.5.tgz $ cd Python-2.5/Doc $ make
This will compile the docs. Specifically, we are interested in the HTML version it creates via LaTeX2HTML. Once it’s complete, you need to place the HTML files somewhere more permanent.
$ sudo cp -r html/ /usr/share/doc/python-2.5-html
Now it’s time to set PYTHONDOCS to the location we just moved the HTML files too. You can do this a few ways, the best method is adding it to the .bash_profile.
$ vi ~/.bash_profile ## Add the following # export PYTHONDOCS=/usr/share/doc/python-2.5-html # Save the file and exit $ source ~/.bash_profile
You’re now ready to start using the doc files with iPython. For convenience, I have attached the compiled files here. Have fun!
