«
»

Generating the Python docs on a Ubuntu GNU/Linux box

By Christian

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: , , , ,

Tags: , , , , ,

This entry was posted on December 4, 2007 at 21:56 and is filed under Python. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.

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

  1. Chris Says:
    February 22, 2008 at 04:09 | Reply

    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