1
<?xml version="1.0" encoding="ascii" ?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
<meta http-equiv="Content-Type" content="text/html; charset=ascii" />
6
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
7
<title>Installing Epydoc</title>
8
<link rel="stylesheet" href="custom.css" type="text/css" />
11
<div class="document" id="installing-epydoc">
12
<h1 class="title">Installing Epydoc</h1>
14
<!-- $Id: manual-install.txt 1692 2008-01-30 17:11:29Z edloper $ -->
15
<div class="section" id="downloading-epydoc">
16
<h1>Downloading Epydoc</h1>
17
<p>Epydoc can be downloaded from the <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=32455">SourceForge download page</a>. Epydoc is
18
available in five formats:</p>
20
<li>RPM (<tt class="docutils literal"><span class="pre">.noarch.rpm</span></tt>)</li>
21
<li>Windows installer (<tt class="docutils literal"><span class="pre">.win32.exe</span></tt>)</li>
22
<li>Source install (<tt class="docutils literal"><span class="pre">.tar.gz</span></tt>)</li>
23
<li>Source install (<tt class="docutils literal"><span class="pre">.zip</span></tt>)</li>
24
<li>Source RPM (<tt class="docutils literal"><span class="pre">.src.rpm</span></tt>)</li>
26
<p>If you are installing on RedHat, I recommend that you use the RPM file. If you
27
are installing on Windows, I recommended that you use the windows installer.
28
Otherwise, you should use one of the source install files.</p>
30
<div class="section" id="getting-epydoc-from-subversion">
31
<h1>Getting Epydoc from Subversion</h1>
32
<p>If you wish to keep up on the latest developments, you can get the latest
33
version of epydoc from the <a class="reference external" href="http://sourceforge.net/svn/?group_id=32455">subversion repository</a>:</p>
34
<pre class="literal-block">
35
[/home/edloper]$ svn co https://epydoc.svn.sourceforge.net/svnroot/epydoc/trunk/epydoc epydoc
36
[/home/edloper]$ ls epydoc
37
Makefile doc man sandbox src
39
<p>This will create a directory named <tt class="docutils literal"><span class="pre">epydoc</span></tt> containing the latest version of
40
epydoc. The <tt class="docutils literal"><span class="pre">epydoc</span></tt> package itself is in <tt class="docutils literal"><span class="pre">epydoc/src/epydoc</span></tt> (so adding
41
<tt class="docutils literal"><span class="pre">epydoc/src</span></tt> to your <tt class="docutils literal"><span class="pre">PYTHONPATH</span></tt> will let you use it). You should
42
periodically update your copy of the subversion repository, to make sure you
43
have all the latest changes:</p>
44
<pre class="literal-block">
45
[/home/edloper/epydoc]$ svn up
47
<p>You can browse the subversion repository <a class="reference external" href="http://epydoc.svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/">here</a>.</p>
49
<div class="section" id="installing-from-the-rpm-file">
50
<h1>Installing from the RPM File</h1>
52
<li><p class="first">Download the RPM file to a directory of your choice.</p>
54
<li><p class="first">Use rpm to install the new package.</p>
55
<pre class="literal-block">
58
[/tmp]# rpm -i epydoc-3.0.1.noarch.rpm
61
<li><p class="first">Once epydoc is installed, you can delete the RPM file.</p>
62
<pre class="literal-block">
63
[/tmp]# rm epydoc-3.0.1.rpm
68
<div class="section" id="installing-from-the-windows-installer">
69
<h1>Installing from the Windows Installer</h1>
70
<ol class="arabic simple">
71
<li>Download and run <tt class="docutils literal"><span class="pre">epydoc-3.0.1.win32.exe</span></tt>.</li>
72
<li>Follow the on-screen instructions. Epydoc will be installed in the epydoc
73
subdirectory of your Python installation directory (typically
74
<tt class="docutils literal"><span class="pre">C:\Python24\</span></tt>).</li>
75
<li>The Windows installer creates two scripts in the <tt class="docutils literal"><span class="pre">Scripts</span></tt> subdirectory of
76
your Python installation directory: <tt class="docutils literal"><span class="pre">epydoc.pyw</span></tt> opens the graphical user
77
interface, and <tt class="docutils literal"><span class="pre">epydoc.py</span></tt> calls the command line interface. If you'd
78
like, you can create shortcuts from these scripts to more convenient
79
locations (such as your desktop or start menu).</li>
80
<li>Once epydoc is installed, you can delete <tt class="docutils literal"><span class="pre">epydoc-3.0.1.win32.exe</span></tt>.</li>
83
<div class="section" id="installing-from-the-source-distribution-using-make">
84
<h1>Installing from the Source Distribution (using make)</h1>
86
<li><p class="first">Download an epydoc source distribution to a directory of your choice, and
88
<pre class="literal-block">
89
[/tmp]$ wget -q http://prdownloads.sourceforge.net/epydoc/epydoc-3.0.1.tar.gz
90
[/tmp]$ gunzip epydoc-3.0.1.tar.gz
91
[/tmp]$ tar -xvf epydoc-3.0.1.tar
94
<li><p class="first">Use <tt class="docutils literal"><span class="pre">make</span> <span class="pre">install</span></tt> in the <tt class="docutils literal"><span class="pre">eydoc-3.0.1/</span></tt> directory to install
96
<pre class="literal-block">
97
[/tmp]$ cd epydoc-3.0.1/
98
[/tmp/epydoc-3.0.1]$ su
100
[/tmp/epydoc-3.0.1]# make install
104
copying build/scripts/epydoc -> /usr/bin
105
changing mode of /usr/bin/epydoc to 100775
108
<li><p class="first">If you'd like to keep a local copy of the documentation, then use <tt class="docutils literal"><span class="pre">make</span>
109
<span class="pre">installdocs</span></tt>. By default, this will install the documentation to
110
<tt class="docutils literal"><span class="pre">/usr/share/doc/</span></tt> and the man pages to <tt class="docutils literal"><span class="pre">/usr/share/man/</span></tt>. If you would
111
prefer to install documentation to different directories (such as
112
<tt class="docutils literal"><span class="pre">/usr/lib/doc</span></tt>), then edit the <tt class="docutils literal"><span class="pre">MAN</span></tt> and <tt class="docutils literal"><span class="pre">DOC</span></tt> variables at the top of
113
<tt class="docutils literal"><span class="pre">Makefile</span></tt> before running <tt class="docutils literal"><span class="pre">make</span> <span class="pre">installdocs</span></tt>.</p>
114
<pre class="literal-block">
115
[/tmp/epydoc-3.0.1]# make installdocs
118
<li><p class="first">Once epydoc is installed, you can delete the installation directory and the
119
source distribution file.</p>
120
<pre class="literal-block">
121
[/tmp/epydoc-3.0.1]# cd ..
122
[/tmp]# rm -r epydoc-3.0.1
123
[/tmp]# rm epydoc-3.0.1.tar
128
<div class="section" id="installing-from-the-source-distribution-without-make">
129
<h1>Installing from the Source Distribution (without make)</h1>
131
<li><p class="first">Download an epydoc source distribution to a directory of your choice, and
133
<pre class="literal-block">
134
[/tmp]$ wget -q http://prdownloads.sourceforge.net/epydoc/epydoc-3.0.1.tar.gz
135
[/tmp]$ gunzip epydoc-3.0.1.tar.gz
136
[/tmp]$ tar -xvf epydoc-3.0.1.tar
139
<li><p class="first">Use the <tt class="docutils literal"><span class="pre">setup.py</span></tt> script in the <tt class="docutils literal"><span class="pre">eydoc-3.0.1/</span></tt> directory to install
141
<pre class="literal-block">
142
[/tmp]$ cd epydoc-3.0.1/
143
[/tmp/epydoc-3.0.1]$ su
145
[/tmp/epydoc-3.0.1]# python setup.py install
149
copying build/scripts/epydoc -> /usr/bin
150
changing mode of /usr/bin/epydoc to 100775
151
[/tmp/epydoc-3.0.1]# cd ..
155
<li><p class="first">If you'd like to keep a local copy of the documentation, then copy it to a
156
permanant location, such as <tt class="docutils literal"><span class="pre">/usr/share/doc/</span></tt>. You may also want to copy
157
the man pages to a permanant location, such as <tt class="docutils literal"><span class="pre">/usr/share/man/</span></tt>.</p>
158
<pre class="literal-block">
159
[/tmp]# cp -r epydoc-3.0.1/doc/ /usr/share/doc/epydoc/
160
[/tmp]# cp epydoc-3.0.1/man/* /usr/share/man/
163
<li><p class="first">Once epydoc is installed, you can delete the installation directory and the
164
source distribution file.</p>
165
<pre class="literal-block">
166
[/tmp]# rm -r epydoc-3.0.1
167
[/tmp]# rm epydoc-3.0.1.tar
172
<div class="section" id="installing-on-debian">
173
<h1>Installing on Debian</h1>
174
<p>Epydoc 2.1 is available as a testing debian package (<tt class="docutils literal"><span class="pre">python-epydoc</span></tt>). The
175
epydoc documentation is also available as a package (<tt class="docutils literal"><span class="pre">epydoc-doc</span></tt>).</p>
178
<table width="100%" class="navbox" cellpadding="1" cellspacing="0">
180
<a class="nav" href="index.html">
181
<td align="center" width="20%" class="nav">
182
<a class="nav" href="index.html">
184
<a class="nav" href="installing.html">
185
<td align="center" width="20%" class="nav">
186
<a class="nav" href="installing.html">
187
Installing Epydoc</a></td></a>
188
<a class="nav" href="using.html">
189
<td align="center" width="20%" class="nav">
190
<a class="nav" href="using.html">
191
Using Epydoc</a></td></a>
192
<a class="nav" href="epytext.html">
193
<td align="center" width="20%" class="nav">
194
<a class="nav" href="epytext.html">
196
<td align="center" width="20%" class="nav">
198
<A href="http://sourceforge.net/projects/epydoc">
199
<IMG src="sflogo.png"
200
width="88" height="26" border="0" alt="SourceForge"
201
align="top"/></A></td>