Skip to Content
Scope: Python projects

Description

The pythonDoc task allows to extract api documentation from python source code. Rather than using the internal documentation tools from python this task uses Epydoc which produces a much nicer document structure. This package is bundled as a library of this ant task so it's not necessary to explicitly perform any kind of installation.

Arguments

The pythonDoc task provides the following arguments:

Argument Description Required
sourcedir A directory containing the python source code. yes
destdir The location where the generated api documentation will be stored to. yes
runtime The id of a python runtime used to generate the documentation with. yes

Example usage

Simple generation of python documentation:

  <ant4eclipse:pythonContainer default="cpython-2.5">
    <ant4eclipse:pyre id="cpython-2.5" location="/usr/lib/cpython/2.5"/>
    <ant4eclipse:pyre id="cpython-2.6" location="/usr/lib/cpython/2.6"/>
  </ant4eclipse:pythonContainer>
 
  <ant4eclipse:pythonDoc 
    runtime="cpython-2.6"
    sourcedir="/users/kasimir/python/sample1/sources"
    destdir="/users/kasimir/python/sample1/apidoc"
  />