Generating the Python docs on a Ubuntu GNU/Linux box

by

The first thing is to checkout the Python and doctools directories from the subversion repositories:

$ svn co http://svn.python.org/projects/python/trunk python
$ svn co http://svn.python.org/projects/doctools/trunk doctools

To install the required tools, as suggested from the doctools/README, I added the following packages:

# apt-get install python-pygments python-docutils

These are the steps really generating the documentation:

$ cd doctools
$ mkdir build-html
$ python sphinx-build.py -b html ../python/Doc build-html

Open the files generated in build-html, e.g. build-html/index.html, using file->open using your favorite web browser.

Everything works pretty straight forward as described in the doctools/README file.

Technorati Tags: , , , ,

Advertisements

Tags: , , , , ,

One Response to “Generating the Python docs on a Ubuntu GNU/Linux box”

  1. Chris Says:

    Unless you compiled Python from the subversion trunk, you might want to use the easy way to install the docs for the Ubuntu/Debian package:

    sudo apt-get install python2.5-doc

    now in a browser, open & bookmark this URL:

    file:///usr/share/doc/python2.5/html/index.html

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s


%d bloggers like this: