1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
OPTIONAL PACKAGES
The epydoc command requires the tetex-bin and tetex-extra packages to use the
--ps and --dvi options, and requires the gs package to use the --pdf option.
In particular, the --ps option requires the latex and makeindex commands from
tetex-bin, the --dvi option requires the dvips command from tetex-bin and the
--pdf option requires the ps2pdf command from gs. The generated LaTeX that
serves as the basis for Postscript, DVI and PDF output includes \usepackage
directives for LaTeX packages such as 'fullpage', which are provided by
tetex-extra.
The epydocgui command requires one of the python-tk packages, either
python2.3-tk, python2.2-tk, python2.1-tk.
All of these optional packages are Recommended in the package dependencies.
OBSOLETE PACKAGES
As of version 2.0-2, all scripts, manpages and Python modules are part of the
python-epydoc package only. The python2.1-epydoc, python2.2-epydoc and
python2.3-eypdoc binary packages are still built from the epydoc source
package. However, these binary packages are effectively empty and can be
safely removed at any time. They exist only to allow for a smooth upgrade from
earlier packages prior to version 2.0-2.
Also as of this version, new epydoc and epydocgui scripts allow the same Python
modules (in the site-python directory) to be used with all versions of Python.
See below for more information.
CHOOSING A PYTHON VERSION
If you have many python versions installed you can choose which python version
to use with epydoc by setting $PYTHONVER to the version number.
Example (sh):
> export PYTHONVER=2.1
csh:
> setenv PYTHONVER 2.1
This may be of limited utility, since most of the time it should be OK to use
the Python 2.3 interpreter to document Python 2.1 or Python 2.2 source code.
However, some people may have a need to use a specific interpreter, and I want
to accommodate them. See the manpages for more details.
Note that if you want to use Epydoc with Python 2.1 or 2.2 you must have the
appropriate python-xmlbase package (python2.1-xmlbase or python2.2-xmlbase)
installed as listed in the package dependencies. Since the python-epydoc
package depends on python2.3 and then optionally other python versions after
that, apt will probably not install either of the xmlbase packages on most
systems by default.
COMPILED PYTHON MODULES
All of the epydoc Python modules are installed into /usr/lib/site-python/epydoc,
so that Python applications other than the epydoc command-line tools can safely
import the modules if they want.
The .pyc and .pyo files in /usr/lib/site-python/epydoc are (must be) built for
a specific version of Python. I've chosen to build the .pyc and .pyo files for
the "best" version of Python on the machine, meaning the first one found of
/usr/bin/python, /usr/bin/python2.3, /usr/bin/python2.2 or /usr/bin/python2.1.
It will still be possible to use the epydoc modules with a different version of
python; however, in this case there will be some inefficiencies, since the
interpreter version won't match the version of the .pyc files on disk, and the
.py files will have to be recompiled on-the fly.
This also means that if you install a newer version of Python after installing
Epydoc (for instance, installing 2.3 when all you had before was 2.1 and the
xmlbase package), all of the .pyc and .pyo files will be out-of-sync with the
new "best" interpreter. For the time being, the only way to remedy this
problem is to run 'dpkg-reconfigure python-epydoc' by hand. This will rebuild
all of the .pyc and .pyo files as if the package were being reinstalled. You
may have to do the same thing if the root user happens to import a epydoc
module using a different version of Python, since this will probably overrwrite
the .pyc or .pyo files in the epydoc module directory.
|
