Changeset 2133 for vendor

Show
Ignore:
Timestamp:
04/06/2007 03:43:34 PM (21 months ago)
Author:
guyer
Message:

Load epydoc-r1588 into vendor/epydoc/current.

Location:
vendor/epydoc/current
Files:
28 modified

Legend:

Unmodified
Added
Removed

  • vendor/epydoc/current/doc/custom.css

    r2127 r2133  
    8484div.epydoc-usage { border: 1px solid #708890;  
    8585                   background: #e8f0f8; margin: 1em; padding: 0.5em} 
    86 table.option-list { background: none !important; } 
     86table.option-list { background: none !important; 
     87                    border: 0px solid black; } 
    8788table.option-list td { border: none !important; } 
    8889 

  • vendor/epydoc/current/doc/fields.html

    r2127 r2133  
    44<link rel="stylesheet" href="epydoc.css" type="text/css"/> 
    55</head> 
    6 <!-- $Id: fields.html 1529 2007-02-18 12:34:08Z dvarrazzo $ --> 
     6<!-- $Id: fields.html 1575 2007-03-08 21:28:07Z edloper $ --> 
    77<body> 
    88<div class="body"> 
    … …  
    365365 
    366366<p> Normally the fields are written in the docstring of the documented 
    367 objects: this allows to add fields to modules, classes, function, properties. 
     367objects: this allows you to add fields to modules, classes, function, properties. 
    368368Where a docstring is not allowed, usually alternative options do exist. 
    369369</p> 

  • vendor/epydoc/current/doc/index.html

    r2127 r2133  
    44<link rel="stylesheet" href="epydoc.css" type="text/css"/> 
    55</head> 
    6 <!-- $Id: index.html 1555 2007-02-27 04:00:10Z edloper $ --> 
     6<!-- $Id: index.html 1562 2007-02-27 09:57:25Z dvarrazzo $ --> 
    77<body> 
    88 
    … …  
    4242  <li> <a href="manual-install.html">Installing Epydoc</a> </li> 
    4343  <li> <a href="manual-usage.html">Using Epydoc</a> </li> 
    44   <li> <a href="manual-docstrings.html">Python Docstrings</a> </li> 
     44  <li> <a href="manual-docstring.html">Python Docstrings</a> </li> 
    4545  <li> <a href="manual-epytext.html">The Epytext Markup Language</a> </li> 
    4646  <li> <a href="manual-fields.html">Epydoc Fields</a> </li> 
    … …  
    9595 
    9696<ul> 
    97 <li> The latest testing release is <a href="http://sourceforge.net/project/showfiles.php?group_id=32455&package_id=24617&release_id=441763">Epydoc 3.0 alpha 3</a>.  </li> 
     97<li> The latest testing release is <a href="http://sourceforge.net/project/platformdownload.php?group_id=32455">Epydoc 3.0 beta 1</a>.  </li> 
    9898 
    9999<li>The 
    … …  
    131131<h2 class="box-title">News</h2> 
    132132 
    133 <p><b>Epydoc 3.0 alpha 3 released [August 2006]</b></br /> The third 
    134 alpha release of epydoc 3.0 is now available on the <a 
    135 href="http://sourceforge.net/project/showfiles.php?group_id=32455">SourceForge 
     133<p><b>Epydoc 3.0 beta 1 released [February 2007]</b></br /> The first 
     134beta release of epydoc 3.0 is now available on the <a 
     135href="http://sourceforge.net/project/platformdownload.php?group_id=32455">SourceForge 
    136136download page</a>.  See the <a href="whatsnew.html">What's New</a> 
    137137page for details.  Epydoc is under active development; if you wish to 

  • vendor/epydoc/current/doc/installing.html

    r2127 r2133  
    44<link rel="stylesheet" href="epydoc.css" type="text/css"/> 
    55</head> 
    6 <!-- $Id: installing.html 1334 2006-08-29 22:12:20Z edloper $ --> 
     6<!-- $Id: installing.html 1558 2007-02-27 05:28:35Z edloper $ --> 
    77 
    88<body> 
    … …  
    8484<code class="prompt">[/tmp]$</code> <code class="user">su</code> 
    8585Password: 
    86 <code class="prompt">[/tmp]#</code> <code class="user">rpm -i epydoc-3.0alpha3.noarch.rpm</code> 
     86<code class="prompt">[/tmp]#</code> <code class="user">rpm -i epydoc-3.0beta1.noarch.rpm</code> 
    8787</pre></div></li> 
    8888 
    … …  
    9090 
    9191<div class="screen"><pre> 
    92 <code class="prompt">[/tmp]#</code> <code class="user">rm epydoc-3.0alpha3.rpm</code> 
     92<code class="prompt">[/tmp]#</code> <code class="user">rm epydoc-3.0beta1.rpm</code> 
    9393</pre></div> </li> 
    9494</ol> 
    … …  
    9898 
    9999<ol> 
    100   <li> Download and run <code>epydoc-3.0alpha3.win32.exe</code>. </li> 
     100  <li> Download and run <code>epydoc-3.0beta1.win32.exe</code>. </li> 
    101101  <li> Follow the on-screen instructions.  Epydoc will be installed in 
    102102  the <code>epydoc</code> subdirectory of your Python installation 
    … …  
    110110  menu). </li> 
    111111  <li> Once epydoc is installed, you can delete 
    112   <code>epydoc-3.0alpha3.win32.exe</code>. </li> 
     112  <code>epydoc-3.0beta1.win32.exe</code>. </li> 
    113113</ol> 
    114114 
    … …  
    121121 
    122122<div class="screen"><pre> 
    123 <code class="prompt">[/tmp]$</code> <code class="user">wget -q http://prdownloads.sourceforge.net/epydoc/epydoc-3.0alpha3.tar.gz</code> 
    124 <code class="prompt">[/tmp]$</code> <code class="user">gunzip epydoc-3.0alpha3.tar.gz</code> 
    125 <code class="prompt">[/tmp]$</code> <code class="user">tar -xvf epydoc-3.0alpha3.tar</code> 
    126 </pre></div></li> 
    127  
    128   <li> Use "<code>make install</code>" in the <code>eydoc-3.0alpha3/</code> 
     123<code class="prompt">[/tmp]$</code> <code class="user">wget -q http://prdownloads.sourceforge.net/epydoc/epydoc-3.0beta1.tar.gz</code> 
     124<code class="prompt">[/tmp]$</code> <code class="user">gunzip epydoc-3.0beta1.tar.gz</code> 
     125<code class="prompt">[/tmp]$</code> <code class="user">tar -xvf epydoc-3.0beta1.tar</code> 
     126</pre></div></li> 
     127 
     128  <li> Use "<code>make install</code>" in the <code>eydoc-3.0beta1/</code> 
    129129  directory to install epydoc. 
    130130 
    131131<div class="screen"><pre> 
    132 <code class="prompt">[/tmp]$</code> <code class="user">cd epydoc-3.0alpha3/</code> 
    133 <code class="prompt">[/tmp/epydoc-3.0alpha3]$</code> <code class="user">su</code> 
     132<code class="prompt">[/tmp]$</code> <code class="user">cd epydoc-3.0beta1/</code> 
     133<code class="prompt">[/tmp/epydoc-3.0beta1]$</code> <code class="user">su</code> 
    134134Password: 
    135 <code class="prompt">[/tmp/epydoc-3.0alpha3]#</code> <code class="user">make install</code> 
     135<code class="prompt">[/tmp/epydoc-3.0beta1]#</code> <code class="user">make install</code> 
    136136running install 
    137137running build 
    … …  
    151151 
    152152<div class="screen"><pre> 
    153 <code class="prompt">[/tmp/epydoc-3.0alpha3]#</code> <code class="user">make installdocs</code> 
     153<code class="prompt">[/tmp/epydoc-3.0beta1]#</code> <code class="user">make installdocs</code> 
    154154</pre></div></li> 
    155155 
    … …  
    158158 
    159159<div class="screen"><pre> 
    160 <code class="prompt">[/tmp/epydoc-3.0alpha3]#</code> <code class="user">cd ..</code> 
    161 <code class="prompt">[/tmp]#</code> <code class="user">rm -r epydoc-3.0alpha3</code> 
    162 <code class="prompt">[/tmp]#</code> <code class="user">rm epydoc-3.0alpha3.tar</code> 
     160<code class="prompt">[/tmp/epydoc-3.0beta1]#</code> <code class="user">cd ..</code> 
     161<code class="prompt">[/tmp]#</code> <code class="user">rm -r epydoc-3.0beta1</code> 
     162<code class="prompt">[/tmp]#</code> <code class="user">rm epydoc-3.0beta1.tar</code> 
    163163</pre></div> </li> 
    164164</ol> 
    … …  
    172172 
    173173<div class="screen"><pre> 
    174 <code class="prompt">[/tmp]$</code> <code class="user">wget -q http://prdownloads.sourceforge.net/epydoc/epydoc-3.0alpha3.tar.gz</code> 
    175 <code class="prompt">[/tmp]$</code> <code class="user">gunzip epydoc-3.0alpha3.tar.gz</code> 
    176 <code class="prompt">[/tmp]$</code> <code class="user">tar -xvf epydoc-3.0alpha3.tar</code> 
     174<code class="prompt">[/tmp]$</code> <code class="user">wget -q http://prdownloads.sourceforge.net/epydoc/epydoc-3.0beta1.tar.gz</code> 
     175<code class="prompt">[/tmp]$</code> <code class="user">gunzip epydoc-3.0beta1.tar.gz</code> 
     176<code class="prompt">[/tmp]$</code> <code class="user">tar -xvf epydoc-3.0beta1.tar</code> 
    177177</pre></div></li> 
    178178 
    179179  <li> Use the <code>setup.py</code> script in the 
    180   <code>eydoc-3.0alpha3/</code> directory to install epydoc.  
    181  
    182 <div class="screen"><pre> 
    183 <code class="prompt">[/tmp]$</code> <code class="user">cd epydoc-3.0alpha3/</code> 
    184 <code class="prompt">[/tmp/epydoc-3.0alpha3]$</code> <code class="user">su</code> 
     180  <code>eydoc-3.0beta1/</code> directory to install epydoc.  
     181 
     182<div class="screen"><pre> 
     183<code class="prompt">[/tmp]$</code> <code class="user">cd epydoc-3.0beta1/</code> 
     184<code class="prompt">[/tmp/epydoc-3.0beta1]$</code> <code class="user">su</code> 
    185185Password: 
    186 <code class="prompt">[/tmp/epydoc-3.0alpha3]#</code> <code class="user">python setup.py install</code> 
     186<code class="prompt">[/tmp/epydoc-3.0beta1]#</code> <code class="user">python setup.py install</code> 
    187187running install 
    188188running build 
    … …  
    190190copying build/scripts/epydoc -> /usr/bin 
    191191changing mode of /usr/bin/epydoc to 100775 
    192 <code class="prompt">[/tmp/epydoc-3.0alpha3]#</code> <code class="user">cd ..</code> 
     192<code class="prompt">[/tmp/epydoc-3.0beta1]#</code> <code class="user">cd ..</code> 
    193193<code class="prompt">[/tmp]#</code> 
    194194</pre></div></li> 
    … …  
    200200 
    201201<div class="screen"><pre> 
    202 <code class="prompt">[/tmp]#</code> <code class="user">cp -r epydoc-3.0alpha3/doc/ /usr/share/doc/epydoc/</code> 
    203 <code class="prompt">[/tmp]#</code> <code class="user">cp epydoc-3.0alpha3/man/* /usr/share/man/</code> 
     202<code class="prompt">[/tmp]#</code> <code class="user">cp -r epydoc-3.0beta1/doc/ /usr/share/doc/epydoc/</code> 
     203<code class="prompt">[/tmp]#</code> <code class="user">cp epydoc-3.0beta1/man/* /usr/share/man/</code> 
    204204</pre></div> </li> 
    205205 
    … …  
    208208 
    209209<div class="screen"><pre> 
    210 <code class="prompt">[/tmp]#</code> <code class="user">rm -r epydoc-3.0alpha3</code> 
    211 <code class="prompt">[/tmp]#</code> <code class="user">rm epydoc-3.0alpha3.tar</code> 
     210<code class="prompt">[/tmp]#</code> <code class="user">rm -r epydoc-3.0beta1</code> 
     211<code class="prompt">[/tmp]#</code> <code class="user">rm epydoc-3.0beta1.tar</code> 
    212212</pre></div> </li> 
    213213</ol> 

  • vendor/epydoc/current/doc/manual-docstring.txt

    r2127 r2133  
    22================= 
    33 
    4 .. $Id: manual-docstring.txt 1548 2007-02-22 00:25:40Z dvarrazzo $ 
     4.. $Id: manual-docstring.txt 1575 2007-03-08 21:28:07Z edloper $ 
    55 
    66Python documentation strings (or *docstrings*) provide a convenient way of 
    … …  
    105105 
    106106For each module and class, Epydoc generates pages with both public and private 
    107 methods. A Javascript snippet allows to toggle the visibility of private 
     107methods. A Javascript snippet allows you to toggle the visibility of private 
    108108objects. 
    109109 

  • vendor/epydoc/current/doc/manual-othermarkup.txt

    r2127 r2133  
    22========================== 
    33 
    4 .. $Id: manual-othermarkup.txt 1551 2007-02-25 16:13:17Z dvarrazzo $ 
     4.. $Id: manual-othermarkup.txt 1575 2007-03-08 21:28:07Z edloper $ 
    55 
    66Epydoc's default markup language is epytext__, a lightweight markup language 
    … …  
    382382~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    383383 
    384 Epydoc provides the script ``apirst2html.py`` which allows to use the 
     384Epydoc provides the script ``apirst2html.py`` which allows you to use the 
    385385previously described interpreted text roles from any reST document. The script 
    386386exposes the same interface of the standard Docutils script ``rst2html.py`` but 

  • vendor/epydoc/current/doc/manual.txt

    r2127 r2133  
    66------------------------------------------------- 
    77 
    8 .. $Id: manual.txt 1554 2007-02-27 03:31:56Z edloper $ 
     8.. $Id: manual.txt 1559 2007-02-27 06:42:46Z edloper $ 
    99 
    1010:Author: `Edward Loper <edloper@gradient.cis.upenn.edu>`__ 
    … …  
    3333.. contents:: 
    3434.. section-numbering:: 
    35 .. def:: singlepage 
    3635 
    3736 

  • vendor/epydoc/current/src/epydoc/__init__.py

    r2127 r2133  
    55# URL: <http://epydoc.sf.net> 
    66# 
    7 # $Id: __init__.py 1347 2006-09-03 03:40:30Z edloper $ 
     7# $Id: __init__.py 1558 2007-02-27 05:28:35Z edloper $ 
    88 
    99""" 
    … …  
    168168:author: `Edward Loper <edloper@gradient.cis.upenn.edu>`__ 
    169169:requires: Python 2.3+ 
    170 :version: 3.0 alpha 2 
     170:version: 3.0 beta 1 
    171171:see: `The epydoc webpage <http://epydoc.sourceforge.net>`__ 
    172172:see: `The epytext markup language 
    … …  
    201201__docformat__ = 'restructuredtext en' 
    202202 
    203 __version__ = '3.0alpha3' 
     203__version__ = '3.0beta1' 
    204204"""The version of epydoc""" 
    205205 

  • vendor/epydoc/current/src/epydoc/apidoc.py

    r2127 r2133  
    55# URL: <http://epydoc.sf.net> 
    66# 
    7 # $Id: apidoc.py 1553 2007-02-27 00:07:56Z edloper $ 
     7# $Id: apidoc.py 1588 2007-03-25 13:37:13Z dvarrazzo $ 
    88 
    99""" 
    … …  
    10111011        """ 
    10121012        if self.sorted_variables is UNKNOWN: 
    1013             self.init_sorted_variables 
     1013            self.init_sorted_variables() 
    10141014        assert len(self.sorted_variables) == len(self.variables) 
    10151015 

  • vendor/epydoc/current/src/epydoc/cli.py

    r2127 r2133  
    55# URL: <http://epydoc.sf.net> 
    66# 
    7 # $Id: cli.py 1549 2007-02-24 16:23:49Z dvarrazzo $ 
     7# $Id: cli.py 1585 2007-03-14 01:53:14Z dvarrazzo $ 
    88 
    99""" 
    … …  
    507507        if optname in ('modules', 'objects', 'values', 
    508508                       'module', 'object', 'value'): 
    509             names.extend(val.replace(',', ' ').split()) 
     509            names.extend(_str_to_list(val)) 
    510510        elif optname == 'target': 
    511511            options.target = val 
    … …  
    530530            options.introspect = _str_to_bool(val, optname) 
    531531        elif optname == 'exclude': 
    532             options.exclude.append(val) 
     532            options.exclude.extend(_str_to_list(val)) 
    533533        elif optname in ('exclude-parse', 'exclude_parse'): 
    534             options.exclude_parse.append(val) 
     534            options.exclude_parse.extend(_str_to_list(val)) 
    535535        elif optname in ('exclude-introspect', 'exclude_introspect'): 
    536             options.exclude_introspect.append(val) 
     536            options.exclude_introspect.extend(_str_to_list(val)) 
    537537        elif optname == 'inheritance': 
    538538            if val.lower() not in INHERITANCE_STYLES: 
    … …  
    569569        # External API 
    570570        elif optname in ('external-api', 'external_api'): 
    571             options.external_api.extend(val.replace(',', ' ').split()) 
     571            options.external_api.extend(_str_to_list(val)) 
    572572        elif optname in ('external-api-file', 'external_api_file'): 
    573             options.external_api_file.append(val) 
     573            options.external_api_file.extend(_str_to_list(val)) 
    574574        elif optname in ('external-api-root', 'external_api_root'): 
    575             options.external_api_root.append(val) 
     575            options.external_api_root.extend(_str_to_list(val)) 
    576576 
    577577        # Graph options 
    578578        elif optname == 'graph': 
    579             graphtypes = val.replace(',', '').split() 
     579            graphtypes = _str_to_list(val) 
    580580            for graphtype in graphtypes: 
    581581                if graphtype not in GRAPH_TYPES + ('all',): 
    … …  
    590590            options.graph_font_size = _str_to_int(val, optname) 
    591591        elif optname == 'pstat': 
    592             options.pstat_files.extend(val.replace(',', ' ').split()) 
     592            options.pstat_files.extend(_str_to_list(val)) 
    593593 
    594594        # Return value options 
    … …  
    620620    except ValueError: 
    621621        raise ValueError('"%s" option expected an int' % optname) 
     622 
     623def _str_to_list(val): 
     624    return val.replace(',', ' ').split() 
    622625 
    623626###################################################################### 

  • vendor/epydoc/current/src/epydoc/docparser.py

    r2127 r2133  
    55# URL: <http://epydoc.sf.net> 
    66# 
    7 # $Id: docparser.py 1511 2007-02-16 02:08:51Z dvarrazzo $ 
     7# $Id: docparser.py 1580 2007-03-10 16:01:52Z dvarrazzo $ 
    88 
    99""" 
    … …  
    231231 
    232232        # Check the cache, first. 
    233         if _moduledoc_cache.has_key(filename): 
     233        if filename in _moduledoc_cache: 
    234234            return _moduledoc_cache[filename] 
    235235         
    … …  
    866866    # >>> from os.path import join, split 
    867867    else: 
    868         src_name = parse_dotted_name(lhs) 
     868        # Allow relative imports in this case, as per PEP 328 
     869        src_name = parse_dotted_name(lhs,  
     870            parent_name=parent_docs[-1].canonical_name) 
    869871        parts = split_on(rhs, (token.OP, ',')) 
    870872        for part in parts: 
    … …  
    16691671    return elt[1] 
    16701672 
    1671 def parse_dotted_name(elt_list, strip_parens=True): 
    1672     """ 
     1673def parse_dotted_name(elt_list, strip_parens=True, parent_name=None): 
     1674    """ 
     1675    @param parent_name: canonical name of referring module, to resolve 
     1676        relative imports. 
     1677    @type parent_name: L{DottedName} 
    16731678    @bug: does not handle 'x.(y).z' 
    16741679    """ 
    … …  
    16841689        elt_list[:1] = elt_list[0][1:-1] 
    16851690 
     1691    # Convert a relative import into an absolute name. 
     1692    prefix_name = None 
     1693    if parent_name is not None and elt_list[0][-1] == '.': 
     1694        items = 1 
     1695        while len(elt_list) > items and elt_list[items][-1] == '.': 
     1696            items += 1 
     1697             
     1698        elt_list = elt_list[items:] 
     1699        prefix_name = parent_name[:-items] 
     1700             
     1701        # >>> from . import foo 
     1702        if not elt_list: 
     1703            return prefix_name 
     1704 
    16861705    if len(elt_list) % 2 != 1: raise ParseError("Bad dotted name") 
    16871706    name = DottedName(parse_name(elt_list[0], True)) 
     1707    if prefix_name is not None: 
     1708        name = prefix_name + name 
     1709         
    16881710    for i in range(2, len(elt_list), 2): 
    16891711        dot, identifier = elt_list[i-1], elt_list[i] 
    … …  
    18721894    # Locals 
    18731895    if isinstance(parent_docs[-1], NamespaceDoc): 
    1874         if parent_docs[-1].variables.has_key(identifier): 
     1896        if identifier in parent_docs[-1].variables: 
    18751897            return parent_docs[-1].variables[identifier] 
    18761898 
    18771899    # Globals (aka the containing module) 
    18781900    if isinstance(parent_docs[0], NamespaceDoc): 
    1879         if parent_docs[0].variables.has_key(identifier): 
     1901        if identifier in parent_docs[0].variables: 
    18801902            return parent_docs[0].variables[identifier] 
    18811903 
    … …  
    18831905    builtins = epydoc.docintrospecter.introspect_docs(__builtin__) 
    18841906    if isinstance(builtins, NamespaceDoc): 
    1885         if builtins.variables.has_key(identifier): 
     1907        if identifier in builtins.variables: 
    18861908            return builtins.variables[identifier] 
    18871909 

  • vendor/epydoc/current/src/epydoc/docstringparser.py

    r2127 r2133  
    55# URL: <http://epydoc.sf.net> 
    66# 
    7 # $Id: docstringparser.py 1529 2007-02-18 12:34:08Z dvarrazzo $ 
     7# $Id: docstringparser.py 1578 2007-03-10 00:10:33Z dvarrazzo $ 
    88 
    99""" 
    … …  
    219219        # Parse ahead the __init__ docstring for this class 
    220220        initvar = api_doc.variables.get('__init__') 
    221         if initvar and initvar.value not in (None, UNKNOWN): 
     221        if initvar and isinstance(initvar.value, RoutineDoc): 
    222222            init_api_doc = initvar.value 
    223223            parse_docstring(init_api_doc, docindex) 
    … …  
    268268 
    269269def add_metadata_from_var(api_doc, field): 
    270     if not field.multivalue: 
    271         for (f,a,d) in api_doc.metadata: 
    272             if field == f: 
    273                 return # We already have a value for this metadata. 
    274270    for varname in field.varnames: 
    275271        # Check if api_doc has a variable w/ the given name. 
    276272        if varname not in api_doc.variables: continue 
     273 
     274        # Check moved here from before the for loop because we expect to 
     275        # reach rarely this point. The loop below is to be performed more than 
     276        # once only for fields with more than one varname, which currently is 
     277        # only 'author'. 
     278        for md in api_doc.metadata: 
     279            if field == md[0]: 
     280                return # We already have a value for this metadata. 
     281 
    277282        var_doc = api_doc.variables[varname] 
    278283        if var_doc.value is UNKNOWN: continue 
    … …  
    508513construct summary descriptions for routines that have empty C{descr}, 
    509514but non-empty C{return_descr}.""" 
     515RETURN_PDS._tree.children[0].attribs['inline'] = True 
    510516 
    511517###################################################################### 

  • vendor/epydoc/current/src/epydoc/docwriter/dotgraph.py

    r2127 r2133  
    55# URL: <http://epydoc.sf.net> 
    66# 
    7 # $Id: dotgraph.py 1510 2007-02-16 01:28:57Z dvarrazzo $ 
     7# $Id: dotgraph.py 1567 2007-03-05 00:53:10Z dvarrazzo $ 
    88 
    99""" 
    … …  
    185185            if caption: 
    186186                s += '<span class="graph-caption">%s</span>' % caption 
    187             s += '\n  </td></tr>\n</table><br/>' 
     187            s += '\n  </td></tr>\n</table><br />' 
    188188        if center: s += '</center>' 
    189189        return s 
    … …  
    865865          - ``depth`` is the depth of the package tree (for coloring) 
    866866          - ``width`` is the max width of the HTML label, roughly in