epydoc-commits Mailing List for Python API documentation generation tool (Page 9)
Brought to you by:
edloper
Menu
▾
▴
epydoc-commits — CVS commit logs for the epydoc project
You can subscribe to this list here.
| 2006 |
Jan
|
Feb
|
Mar
|
Apr
(77) |
May
|
Jun
(6) |
Jul
(8) |
Aug
(91) |
Sep
(67) |
Oct
(4) |
Nov
|
Dec
(1) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2007 |
Jan
(17) |
Feb
(135) |
Mar
(25) |
Apr
|
May
(1) |
Jun
(1) |
Jul
(7) |
Aug
|
Sep
(62) |
Oct
(1) |
Nov
(3) |
Dec
|
| 2008 |
Jan
(40) |
Feb
(102) |
Mar
(5) |
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
| 2009 |
Jan
|
Feb
(2) |
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
|
From: <ed...@us...> - 2007-09-23 05:58:58
|
Revision: 1612
http://epydoc.svn.sourceforge.net/epydoc/?rev=1612&view=rev
Author: edloper
Date: 2007-09-22 22:58:51 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
added "inline" option
Modified Paths:
--------------
trunk/epydoc/src/epydoc/markup/epytext.py
Modified: trunk/epydoc/src/epydoc/markup/epytext.py
===================================================================
--- trunk/epydoc/src/epydoc/markup/epytext.py 2007-09-23 05:32:29 UTC (rev 1611)
+++ trunk/epydoc/src/epydoc/markup/epytext.py 2007-09-23 05:58:51 UTC (rev 1612)
@@ -1623,7 +1623,7 @@
Currently, no extra options are defined.
@rtype: L{ParsedDocstring}
"""
- return ParsedEpytextDocstring(parse(docstring, errors))
+ return ParsedEpytextDocstring(parse(docstring, errors), **options)
class ParsedEpytextDocstring(ParsedDocstring):
SYMBOL_TO_HTML = {
@@ -1726,11 +1726,15 @@
r'\(\prod\)', '<=': r'\(\le\)', '>=': r'\(\ge\)',
}
- def __init__(self, dom_tree):
+ def __init__(self, dom_tree, **options):
self._tree = dom_tree
# Caching:
self._html = self._latex = self._plaintext = None
self._terms = None
+ # inline option -- mark top-level children as inline.
+ if options.get('inline'):
+ for elt in self._tree.children:
+ elt.attribs['inline'] = True
def __str__(self):
return str(self._tree)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-23 05:32:31
|
Revision: 1611
http://epydoc.svn.sourceforge.net/epydoc/?rev=1611&view=rev
Author: edloper
Date: 2007-09-22 22:32:29 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
for function signatures in docstrings, treat the value after -> as a return type, not a return value.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docstringparser.py
Modified: trunk/epydoc/src/epydoc/docstringparser.py
===================================================================
--- trunk/epydoc/src/epydoc/docstringparser.py 2007-09-23 04:19:57 UTC (rev 1610)
+++ trunk/epydoc/src/epydoc/docstringparser.py 2007-09-23 05:32:29 UTC (rev 1611)
@@ -1061,7 +1061,7 @@
# Extract the return type/value from the signature
if rtype:
- func_doc.return_descr = markup.parse(rtype, 'plaintext')
+ func_doc.return_type = markup.parse(rtype, 'plaintext')
# Add the self parameter, if it was specified.
if selfparam:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-23 04:19:58
|
Revision: 1610
http://epydoc.svn.sourceforge.net/epydoc/?rev=1610&view=rev
Author: edloper
Date: 2007-09-22 21:19:57 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
- Fixed 3 bugs in config file parsing, that resulted in options getting
ignored (sf bug 1721683)
Modified Paths:
--------------
trunk/epydoc/src/epydoc/cli.py
Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================
--- trunk/epydoc/src/epydoc/cli.py 2007-09-23 04:11:50 UTC (rev 1609)
+++ trunk/epydoc/src/epydoc/cli.py 2007-09-23 04:19:57 UTC (rev 1610)
@@ -538,11 +538,11 @@
if val.lower() not in INHERITANCE_STYLES:
raise ValueError('"%s" expected one of: %s.' %
(optname, ', '.join(INHERITANCE_STYLES)))
- options.inerhitance = val.lower()
+ options.inheritance = val.lower()
elif optname =='private':
- options.private = _str_to_bool(val, optname)
+ options.show_private = _str_to_bool(val, optname)
elif optname =='imports':
- options.imports = _str_to_bool(val, optname)
+ options.show_imports = _str_to_bool(val, optname)
elif optname == 'sourcecode':
options.include_source_code = _str_to_bool(val, optname)
elif optname in ('include-log', 'include_log'):
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-23 04:11:53
|
Revision: 1609
http://epydoc.svn.sourceforge.net/epydoc/?rev=1609&view=rev
Author: edloper
Date: 2007-09-22 21:11:50 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
- Attempt to fix sf bug 1671154
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docintrospecter.py
Modified: trunk/epydoc/src/epydoc/docintrospecter.py
===================================================================
--- trunk/epydoc/src/epydoc/docintrospecter.py 2007-09-23 03:40:08 UTC (rev 1608)
+++ trunk/epydoc/src/epydoc/docintrospecter.py 2007-09-23 04:11:50 UTC (rev 1609)
@@ -211,6 +211,7 @@
# anything else. (Typically this is true if this module was
# imported, but is not included in the set of modules we're
# documenting.)
+ module_doc.variables = {}
if preliminary: return
# Record the module's docstring
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-23 03:40:09
|
Revision: 1608
http://epydoc.svn.sourceforge.net/epydoc/?rev=1608&view=rev
Author: edloper
Date: 2007-09-22 20:40:08 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
- Fixed typo
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docwriter/html.py
Modified: trunk/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/html.py 2007-09-23 02:44:21 UTC (rev 1607)
+++ trunk/epydoc/src/epydoc/docwriter/html.py 2007-09-23 03:40:08 UTC (rev 1608)
@@ -32,7 +32,7 @@
######################################################################
## Template Compiler
######################################################################
-# The compile_tempalte() method defined in this section is used to
+# The compile_template() method defined in this section is used to
# define several of HTMLWriter's methods.
def compile_template(docstring, template_string,
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-23 02:44:23
|
Revision: 1607
http://epydoc.svn.sourceforge.net/epydoc/?rev=1607&view=rev
Author: edloper
Date: 2007-09-22 19:44:21 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
- Fixed sf bug 1796723 -- don't compare user objects using 'in' or '==',
because they might override __cmp__ to lie or to thrown an exception;
use 'is' instead.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docstringparser.py
Modified: trunk/epydoc/src/epydoc/docstringparser.py
===================================================================
--- trunk/epydoc/src/epydoc/docstringparser.py 2007-09-23 02:17:25 UTC (rev 1606)
+++ trunk/epydoc/src/epydoc/docstringparser.py 2007-09-23 02:44:21 UTC (rev 1607)
@@ -451,12 +451,16 @@
filename = '??'
# [xx] Don't report markup errors for standard builtins.
- if (isinstance(api_doc, ValueDoc) and api_doc != module and
- (api_doc.pyval in __builtin__.__dict__.values() or
- (module not in (None, UNKNOWN) and
- module.pyval in (__builtin__, exceptions)))):
- return
-
+ # n.b. that we must use 'is' to compare pyvals here -- if we use
+ # 'in' or '==', then a user __cmp__ method might raise an
+ # exception, or lie.
+ if isinstance(api_doc, ValueDoc) and api_doc != module:
+ if module not in (None, UNKNOWN) and module.pyval is exceptions:
+ return
+ for builtin_val in __builtin__.__dict__.values():
+ if builtin_val is api_doc.pyval:
+ return
+
# Get the start line of the docstring containing the error.
startline = api_doc.docstring_lineno
if startline in (None, UNKNOWN):
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-23 02:17:27
|
Revision: 1606
http://epydoc.svn.sourceforge.net/epydoc/?rev=1606&view=rev
Author: edloper
Date: 2007-09-22 19:17:25 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
- If we find a name that violated DottedName._IDENTIFIER_RE, then issue
a warning rather than raising an exception. This shouldn't *normally*
happen, but it can happen, eg if someone directly modifies
globals() or uses __import__. Fixes debian bug #433424, and SF bugs
1760011, 1796723 (partial).
Modified Paths:
--------------
trunk/epydoc/src/epydoc/apidoc.py
Modified: trunk/epydoc/src/epydoc/apidoc.py
===================================================================
--- trunk/epydoc/src/epydoc/apidoc.py 2007-09-23 01:48:58 UTC (rev 1605)
+++ trunk/epydoc/src/epydoc/apidoc.py 2007-09-23 02:17:25 UTC (rev 1606)
@@ -111,11 +111,12 @@
elif isinstance(piece, basestring):
for subpiece in piece.split('.'):
if piece not in self._ok_identifiers:
- if self._IDENTIFIER_RE.match(subpiece):
- self._ok_identifiers.add(piece)
- else:
- raise DottedName.InvalidDottedName(
- 'Bad identifier %r' % (piece,))
+ if not self._IDENTIFIER_RE.match(subpiece):
+ #raise DottedName.InvalidDottedName(
+ # 'Bad identifier %r' % (piece,))
+ log.warning("Identifier %r looks suspicious; "
+ "using it anyway." % piece)
+ self._ok_identifiers.add(piece)
self._identifiers.append(subpiece)
else:
raise TypeError('Bad identifier %r: expected '
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-23 01:49:00
|
Revision: 1605
http://epydoc.svn.sourceforge.net/epydoc/?rev=1605&view=rev
Author: edloper
Date: 2007-09-22 18:48:58 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
- Fixed bug in _terms_from_docstring introduced by recent checkin
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docwriter/html.py
Modified: trunk/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/html.py 2007-09-22 19:32:26 UTC (rev 1604)
+++ trunk/epydoc/src/epydoc/docwriter/html.py 2007-09-23 01:48:58 UTC (rev 1605)
@@ -2866,7 +2866,7 @@
if parsed_docstring in (None, UNKNOWN): return []
terms = []
# Strip any existing anchor off:
- base_url = re.sub('#.*', '', base_url)
+ base_url = re.sub('#.*', '', '%s' % (base_url,))
for term in parsed_docstring.index_terms():
anchor = self._term_index_to_anchor(term)
url = '%s#%s' % (base_url, anchor)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-22 19:32:29
|
Revision: 1604
http://epydoc.svn.sourceforge.net/epydoc/?rev=1604&view=rev
Author: edloper
Date: 2007-09-22 12:32:26 -0700 (Sat, 22 Sep 2007)
Log Message:
-----------
Added question about epytext docstrings rendered as plaintext
Modified Paths:
--------------
trunk/epydoc/doc/faq.html
Modified: trunk/epydoc/doc/faq.html
===================================================================
--- trunk/epydoc/doc/faq.html 2007-09-21 23:17:34 UTC (rev 1603)
+++ trunk/epydoc/doc/faq.html 2007-09-22 19:32:26 UTC (rev 1604)
@@ -21,6 +21,8 @@
<li><a href="#new_markup">Will you
add support for my favorite markup language <i>xyz</i>?</a></li>
<li><a href="#new_field">Is there a way to define a new field?</a></li>
+ <li><a href="#epytext_fail">Why does epydoc render one of my epytext-formatted
+ docstrings as plaintext?</a></li>
</ul></p>
<p><b>Extracting Documentation</b>
<ul class="nomargin">
@@ -111,10 +113,31 @@
<dd><p>You can add new fields that describe simple metadata using
the <code>@newfield</code> field. See the documentation for <a
href="fields.html#newfield">fields</a>
- for more information. </p></dd> </p></dd>
+ for more information. </p></dd>
</dl>
+ <!-- QUESTION --><a name="epytext_fail" />
+ <dt><p><b>Q:</b> Why does epydoc render one of my
+ epytext-formatted docstrings as plaintext? </p></dt>
+
+ <dd><p>Since epytext is used as the default markup language for
+ epydoc, it needs to be very conservative -- it will be used to
+ display many docstrings that are not explicitly written using
+ epytext, and it needs to display those docstrings in a readable way.
+ Therefore, whenever epytext encounters a docstring that doesn't
+ strictly conform to the epytext markup language, it renders it as
+ plaintext. </p>
+
+ <p>If you expect one of your docstrings to be processed using
+ epytext, but it gets rendered as plaintext, then the docstring most
+ likely contains one or more markup errors. Run epydoc with the
+ <code>-v</code> option to see markup errors, and check for an error
+ in the docstring in question. Once you fix the markup errors, the
+ docstring will be processed as expected.</p></dd>
+
+</dl>
+
<!-- ================ EXTRACTING DOCUMENTATION ===================== -->
<h2>Extracting Documentation</h2>
<dl class="faq">
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-21 23:17:46
|
Revision: 1603
http://epydoc.svn.sourceforge.net/epydoc/?rev=1603&view=rev
Author: edloper
Date: 2007-09-21 16:17:34 -0700 (Fri, 21 Sep 2007)
Log Message:
-----------
fixed incorrect linking for index terms in functions (sf bug 1791281, debian bug 441368)
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docwriter/html.py
Modified: trunk/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/html.py 2007-09-21 23:11:25 UTC (rev 1602)
+++ trunk/epydoc/src/epydoc/docwriter/html.py 2007-09-21 23:17:34 UTC (rev 1603)
@@ -2865,6 +2865,8 @@
def _terms_from_docstring(self, base_url, container, parsed_docstring):
if parsed_docstring in (None, UNKNOWN): return []
terms = []
+ # Strip any existing anchor off:
+ base_url = re.sub('#.*', '', base_url)
for term in parsed_docstring.index_terms():
anchor = self._term_index_to_anchor(term)
url = '%s#%s' % (base_url, anchor)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-21 23:11:40
|
Revision: 1602
http://epydoc.svn.sourceforge.net/epydoc/?rev=1602&view=rev
Author: edloper
Date: 2007-09-21 16:11:25 -0700 (Fri, 21 Sep 2007)
Log Message:
-----------
fixed __all__ for classes (sf bug 1758565)
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docintrospecter.py
Modified: trunk/epydoc/src/epydoc/docintrospecter.py
===================================================================
--- trunk/epydoc/src/epydoc/docintrospecter.py 2007-09-21 22:51:53 UTC (rev 1601)
+++ trunk/epydoc/src/epydoc/docintrospecter.py 2007-09-21 23:11:25 UTC (rev 1602)
@@ -332,10 +332,10 @@
class_doc.docstring = get_docstring(cls)
# Record the class's __all__ attribute (public names).
+ public_names = None
if hasattr(cls, '__all__'):
try:
- public_names = [str(name) for name in cls.__all__]
- class_doc.public_names = public_names
+ public_names = set([str(name) for name in cls.__all__])
except KeyboardInterrupt: raise
except: pass
@@ -394,13 +394,13 @@
if child_name.startswith(private_prefix):
child_name = child_name[len(private_prefix)-2:]
if child_name in UNDOCUMENTED_CLASS_VARS: continue
- #try: child = getattr(cls, child_name)
- #except: continue
val_doc = introspect_docs(child, context=class_doc,
module_name=module_name)
var_doc = VariableDoc(name=child_name, value=val_doc,
container=class_doc,
docs_extracted_by='introspecter')
+ if public_names is not None:
+ var_doc.is_public = (child_name in public_names)
class_doc.variables[child_name] = var_doc
return class_doc
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-21 22:51:54
|
Revision: 1601
http://epydoc.svn.sourceforge.net/epydoc/?rev=1601&view=rev
Author: edloper
Date: 2007-09-21 15:51:53 -0700 (Fri, 21 Sep 2007)
Log Message:
-----------
changed script shebang to /usr/bin/env python
Modified Paths:
--------------
trunk/epydoc/src/scripts/epydoc
trunk/epydoc/src/scripts/epydoc.py
trunk/epydoc/src/scripts/epydoc.pyw
trunk/epydoc/src/scripts/epydocgui
Modified: trunk/epydoc/src/scripts/epydoc
===================================================================
--- trunk/epydoc/src/scripts/epydoc 2007-09-21 22:49:26 UTC (rev 1600)
+++ trunk/epydoc/src/scripts/epydoc 2007-09-21 22:51:53 UTC (rev 1601)
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/env python
#
# Call the command line interface for Epydoc.
#
Modified: trunk/epydoc/src/scripts/epydoc.py
===================================================================
--- trunk/epydoc/src/scripts/epydoc.py 2007-09-21 22:49:26 UTC (rev 1600)
+++ trunk/epydoc/src/scripts/epydoc.py 2007-09-21 22:51:53 UTC (rev 1601)
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/env python
#
# Call the command line interface for Epydoc.
#
Modified: trunk/epydoc/src/scripts/epydoc.pyw
===================================================================
--- trunk/epydoc/src/scripts/epydoc.pyw 2007-09-21 22:49:26 UTC (rev 1600)
+++ trunk/epydoc/src/scripts/epydoc.pyw 2007-09-21 22:51:53 UTC (rev 1601)
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/env python
#
# Call the graphical interface for Epydoc.
#
Modified: trunk/epydoc/src/scripts/epydocgui
===================================================================
--- trunk/epydoc/src/scripts/epydocgui 2007-09-21 22:49:26 UTC (rev 1600)
+++ trunk/epydoc/src/scripts/epydocgui 2007-09-21 22:51:53 UTC (rev 1601)
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/env python
#
# Call the graphical interface for Epydoc.
#
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-21 22:49:33
|
Revision: 1600
http://epydoc.svn.sourceforge.net/epydoc/?rev=1600&view=rev
Author: edloper
Date: 2007-09-21 15:49:26 -0700 (Fri, 21 Sep 2007)
Log Message:
-----------
fixed svn url (sf bug #1796882)
Modified Paths:
--------------
trunk/epydoc/doc/installing.html
trunk/epydoc/doc/manual-install.txt
Modified: trunk/epydoc/doc/installing.html
===================================================================
--- trunk/epydoc/doc/installing.html 2007-09-21 22:46:28 UTC (rev 1599)
+++ trunk/epydoc/doc/installing.html 2007-09-21 22:49:26 UTC (rev 1600)
@@ -50,7 +50,7 @@
repository</a>:</p>
<div class="screen"><pre>
-<code class="prompt">[/home/edloper]$</code> <code class="user">svn co https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc epydoc</code>
+<code class="prompt">[/home/edloper]$</code> <code class="user">svn co https://epydoc.svn.sourceforge.net/svnroot/epydoc/trunk/epydoc epydoc</code>
<code class="prompt">[/home/edloper]$</code> <code class="user">ls epydoc</code>
Makefile doc man sandbox src
</pre>
@@ -69,7 +69,7 @@
</div>
<p>You can browse the subversion repository <a
-href="http://svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/">here</a>.</p>
+href="http://epydoc.svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/">here</a>.</p>
<a name="rpm"></a>
Modified: trunk/epydoc/doc/manual-install.txt
===================================================================
--- trunk/epydoc/doc/manual-install.txt 2007-09-21 22:46:28 UTC (rev 1599)
+++ trunk/epydoc/doc/manual-install.txt 2007-09-21 22:49:26 UTC (rev 1600)
@@ -29,7 +29,7 @@
If you wish to keep up on the latest developments, you can get the latest
version of epydoc from the `subversion repository`_::
- [/home/edloper]$ svn co https://svn.sourceforge.net/svnroot/epydoc/trunk/epydoc epydoc
+ [/home/edloper]$ svn co https://epydoc.svn.sourceforge.net/svnroot/epydoc/trunk/epydoc epydoc
[/home/edloper]$ ls epydoc
Makefile doc man sandbox src
@@ -44,7 +44,7 @@
You can browse the subversion repository here__.
.. _subversion repository: http://sourceforge.net/svn/?group_id=32455
-.. __: http://svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/
+.. __: http://epydoc.svn.sourceforge.net/viewcvs.cgi/epydoc/trunk/epydoc/
Installing from the RPM File
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-09-21 22:46:29
|
Revision: 1599
http://epydoc.svn.sourceforge.net/epydoc/?rev=1599&view=rev
Author: edloper
Date: 2007-09-21 15:46:28 -0700 (Fri, 21 Sep 2007)
Log Message:
-----------
fixed -V option [sf bug 1795126]
Modified Paths:
--------------
trunk/epydoc/src/epydoc/gui.py
Modified: trunk/epydoc/src/epydoc/gui.py
===================================================================
--- trunk/epydoc/src/epydoc/gui.py 2007-09-06 13:02:50 UTC (rev 1598)
+++ trunk/epydoc/src/epydoc/gui.py 2007-09-21 22:46:28 UTC (rev 1599)
@@ -1120,7 +1120,7 @@
modules = []
for arg in sys.argv[1:]:
if arg[0] == '-':
- arg = arg.lower()
+ if arg != '-V': arg = arg.lower()
if arg in ('-h', '--help', '-?', '--usage'): _usage()
elif arg in ('-V', '--version'): _version()
elif arg in ('--debug',): DEBUG = 1
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-09-06 13:02:51
|
Revision: 1598
http://epydoc.svn.sourceforge.net/epydoc/?rev=1598&view=rev
Author: dvarrazzo
Date: 2007-09-06 06:02:50 -0700 (Thu, 06 Sep 2007)
Log Message:
-----------
- Typo fixed.
Modified Paths:
--------------
trunk/epydoc/doc/manual-othermarkup.txt
Modified: trunk/epydoc/doc/manual-othermarkup.txt
===================================================================
--- trunk/epydoc/doc/manual-othermarkup.txt 2007-07-25 04:59:18 UTC (rev 1597)
+++ trunk/epydoc/doc/manual-othermarkup.txt 2007-09-06 13:02:50 UTC (rev 1598)
@@ -148,7 +148,7 @@
- Corresponding Base Field Tag
* - ``:Parameters:``
- ``:param:``
- * - ``:Exception:``
+ * - ``:Exceptions:``
- ``:except:``
* - ``:Groups:``
- ``:group:``
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-07-25 04:59:23
|
Revision: 1597
http://svn.sourceforge.net/epydoc/?rev=1597&view=rev
Author: edloper
Date: 2007-07-24 21:59:18 -0700 (Tue, 24 Jul 2007)
Log Message:
-----------
added options -n, -c, -u (svn bug 1760001, debain bug #433804); fixed bug in code to print an error message
Modified Paths:
--------------
trunk/epydoc/man/epydoc.1
trunk/epydoc/src/epydoc/cli.py
Modified: trunk/epydoc/man/epydoc.1
===================================================================
--- trunk/epydoc/man/epydoc.1 2007-07-11 00:47:31 UTC (rev 1596)
+++ trunk/epydoc/man/epydoc.1 2007-07-25 04:59:18 UTC (rev 1597)
@@ -254,7 +254,7 @@
used.
.\" --name
.TP
-.BI "\-\-name " name
+.BI "\-n " name ", \-\-name " name
The name of the project whose documentation is being generated.
.\" --url
.TP
Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================
--- trunk/epydoc/src/epydoc/cli.py 2007-07-11 00:47:31 UTC (rev 1596)
+++ trunk/epydoc/src/epydoc/cli.py 2007-07-25 04:59:18 UTC (rev 1597)
@@ -289,16 +289,16 @@
output_group = OptionGroup(optparser, 'Output Options')
optparser.add_option_group(output_group)
- output_group.add_option("--name",
+ output_group.add_option("--name", "-n",
dest="prj_name", metavar="NAME",
help="The documented project's name (for the navigation bar).")
- output_group.add_option("--css",
+ output_group.add_option("--css", "-c",
dest="css", metavar="STYLESHEET",
help="The CSS stylesheet. STYLESHEET can be either a "
"builtin stylesheet or the name of a CSS file.")
- output_group.add_option("--url",
+ output_group.add_option("--url", "-u",
dest="prj_url", metavar="URL",
help="The documented project's URL (for the navigation bar).")
@@ -440,7 +440,7 @@
for name in names:
if name.endswith('.pickle'):
if len(names) != 1:
- optparse.error("When a pickle file is specified, no other "
+ optparser.error("When a pickle file is specified, no other "
"input files may be specified.")
options.load_pickle = True
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-07-11 00:47:32
|
Revision: 1596
http://svn.sourceforge.net/epydoc/?rev=1596&view=rev
Author: dvarrazzo
Date: 2007-07-10 17:47:31 -0700 (Tue, 10 Jul 2007)
Log Message:
-----------
- Fixed error in _SplitFieldsTranslator error reporting. Fixes SF bug 1738406.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/markup/restructuredtext.py
Modified: trunk/epydoc/src/epydoc/markup/restructuredtext.py
===================================================================
--- trunk/epydoc/src/epydoc/markup/restructuredtext.py 2007-07-11 00:23:30 UTC (rev 1595)
+++ trunk/epydoc/src/epydoc/markup/restructuredtext.py 2007-07-11 00:47:31 UTC (rev 1596)
@@ -165,6 +165,7 @@
def split_fields(self, errors=None):
# Inherit docs
+ if errors is None: errors = []
visitor = _SplitFieldsTranslator(self._document, errors)
self._document.walk(visitor)
if len(self._document.children) > 0:
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-07-11 00:23:37
|
Revision: 1595
http://svn.sourceforge.net/epydoc/?rev=1595&view=rev
Author: dvarrazzo
Date: 2007-07-10 17:23:30 -0700 (Tue, 10 Jul 2007)
Log Message:
-----------
- Inheriting parameters from overridden method docstring (fixes SF bug 1707314).
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docbuilder.py
Modified: trunk/epydoc/src/epydoc/docbuilder.py
===================================================================
--- trunk/epydoc/src/epydoc/docbuilder.py 2007-07-10 23:35:46 UTC (rev 1594)
+++ trunk/epydoc/src/epydoc/docbuilder.py 2007-07-11 00:23:30 UTC (rev 1595)
@@ -1310,5 +1310,5 @@
elif (src_val is not None and
hasattr(val_doc, attrib) and hasattr(src_val, attrib) and
getattr(src_val, attrib) not in (None, UNKNOWN) and
- getattr(val_doc, attrib) in (None, UNKNOWN)):
+ getattr(val_doc, attrib) in (None, UNKNOWN, [])):
setattr(val_doc, attrib, getattr(src_val, attrib))
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-07-10 23:35:54
|
Revision: 1594
http://svn.sourceforge.net/epydoc/?rev=1594&view=rev
Author: dvarrazzo
Date: 2007-07-10 16:35:46 -0700 (Tue, 10 Jul 2007)
Log Message:
-----------
- Suspended `GenericValueDoc` merge: if the parser can't detect the
proper value (because it is dynamically replaced at import time) but its
pyval is not UNKNOWN, the introspected value replaces the parsed values not
only in the specific case, but anywhere else, because all the merged values
share the same dictionary (the Borg!)
The bug is described in SF bug #1678046.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docbuilder.py
Modified: trunk/epydoc/src/epydoc/docbuilder.py
===================================================================
--- trunk/epydoc/src/epydoc/docbuilder.py 2007-07-10 23:24:01 UTC (rev 1593)
+++ trunk/epydoc/src/epydoc/docbuilder.py 2007-07-10 23:35:46 UTC (rev 1594)
@@ -800,13 +800,19 @@
# If both values are GenericValueDoc, then we don't want to merge
# them. E.g., we don't want to merge 2+2 with 4. So just copy
# the inspect_doc's pyval to the parse_doc, and return the parse_doc.
- if type(introspect_doc) == type(parse_doc) == GenericValueDoc:
- if introspect_doc.pyval is not UNKNOWN:
- parse_doc.pyval = introspect_doc.pyval
- if introspect_doc.parse_repr is not UNKNOWN:
- parse_doc.parse_repr = introspect_doc.parse_repr
- parse_doc.docs_extracted_by = 'both'
- return parse_doc.merge_and_overwrite(introspect_doc)
+ #
+ # This operation has been suspended for the reason explained in
+ # SF bug 1678046: the values can be totally uncorrelated if the
+ # introspected value has been changed as collateral effect by a function
+ # executed at runtime.
+ #
+ #if type(introspect_doc) == type(parse_doc) == GenericValueDoc:
+ #if introspect_doc.pyval is not UNKNOWN:
+ #parse_doc.pyval = introspect_doc.pyval
+ #if introspect_doc.parse_repr is not UNKNOWN:
+ #parse_doc.parse_repr = introspect_doc.parse_repr
+ #parse_doc.docs_extracted_by = 'both'
+ #return parse_doc.merge_and_overwrite(introspect_doc)
# Perform several sanity checks here -- if we accidentally
# merge values that shouldn't get merged, then bad things can
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-07-10 23:24:03
|
Revision: 1593
http://svn.sourceforge.net/epydoc/?rev=1593&view=rev
Author: dvarrazzo
Date: 2007-07-10 16:24:01 -0700 (Tue, 10 Jul 2007)
Log Message:
-----------
- Added a test case for bug SF 1693253 fixed in r1592.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/test/docparser.doctest
Modified: trunk/epydoc/src/epydoc/test/docparser.doctest
===================================================================
--- trunk/epydoc/src/epydoc/test/docparser.doctest 2007-07-10 23:16:30 UTC (rev 1592)
+++ trunk/epydoc/src/epydoc/test/docparser.doctest 2007-07-10 23:24:01 UTC (rev 1593)
@@ -785,3 +785,9 @@
+- GenericValueDoc [4]
+ >>> runparser(s="""
+ ... Exception.x = 10
+ ... """,
+ ... attribs='variables value local_variables')
+ ModuleDoc for epydoc_test [0]
+ +- variables = {}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-07-10 23:16:32
|
Revision: 1592
http://svn.sourceforge.net/epydoc/?rev=1592&view=rev
Author: dvarrazzo
Date: 2007-07-10 16:16:30 -0700 (Tue, 10 Jul 2007)
Log Message:
-----------
- Checking that the `NamespaceDoc.sort_spec` is populated. This is not the case when
assigning an attribute to a namespace which has never been parsed.
See SF bug #1693253.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docparser.py
Modified: trunk/epydoc/src/epydoc/docparser.py
===================================================================
--- trunk/epydoc/src/epydoc/docparser.py 2007-07-10 22:01:12 UTC (rev 1591)
+++ trunk/epydoc/src/epydoc/docparser.py 2007-07-10 23:16:30 UTC (rev 1592)
@@ -1839,6 +1839,12 @@
# Choose which dictionary we'll be storing the variable in.
if not isinstance(namespace, NamespaceDoc):
return
+
+ # This happens when the class definition has not been parsed, e.g. in
+ # sf bug #1693253 on ``Exception.x = y``
+ if namespace.sort_spec is UNKNOWN:
+ namespace.sort_spec = namespace.variables.keys()
+
# If we already have a variable with this name, then remove the
# old VariableDoc from the sort_spec list; and if we gave its
# value a canonical name, then delete it.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-07-10 22:01:13
|
Revision: 1591
http://svn.sourceforge.net/epydoc/?rev=1591&view=rev
Author: dvarrazzo
Date: 2007-07-10 15:01:12 -0700 (Tue, 10 Jul 2007)
Log Message:
-----------
- Added __xor__ method description (SF bug #1696396)
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docwriter/html.py
Modified: trunk/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/html.py 2007-06-29 12:11:38 UTC (rev 1590)
+++ trunk/epydoc/src/epydoc/docwriter/html.py 2007-07-10 22:01:12 UTC (rev 1591)
@@ -2351,6 +2351,7 @@
'__sub__': 'Subtraction operator',
'__and__': 'And operator',
'__or__': 'Or operator',
+ '__xor__': 'Exclusive-Or operator',
'__repr__': 'Representation operator',
'__call__': 'Call operator',
'__getattr__': 'Qualification operator',
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ed...@us...> - 2007-06-29 12:11:40
|
Revision: 1590
http://svn.sourceforge.net/epydoc/?rev=1590&view=rev
Author: edloper
Date: 2007-06-29 05:11:38 -0700 (Fri, 29 Jun 2007)
Log Message:
-----------
fixed import bug
Modified Paths:
--------------
trunk/epydoc/src/epydoc/markup/epytext.py
Modified: trunk/epydoc/src/epydoc/markup/epytext.py
===================================================================
--- trunk/epydoc/src/epydoc/markup/epytext.py 2007-05-10 17:45:21 UTC (rev 1589)
+++ trunk/epydoc/src/epydoc/markup/epytext.py 2007-06-29 12:11:38 UTC (rev 1590)
@@ -1851,6 +1851,7 @@
docindex, context):
# Generate the graph
if graph_type == 'classtree':
+ from epydoc.apidoc import ClassDoc
if graph_args:
bases = [docindex.find(name, context)
for name in graph_args]
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-05-10 17:45:36
|
Revision: 1589
http://svn.sourceforge.net/epydoc/?rev=1589&view=rev
Author: dvarrazzo
Date: 2007-05-10 10:45:21 -0700 (Thu, 10 May 2007)
Log Message:
-----------
- A function signature is recognized if arguments with default values are
represented with whitespaces before the '=' sign.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/docstringparser.py
Modified: trunk/epydoc/src/epydoc/docstringparser.py
===================================================================
--- trunk/epydoc/src/epydoc/docstringparser.py 2007-03-25 13:37:13 UTC (rev 1588)
+++ trunk/epydoc/src/epydoc/docstringparser.py 2007-05-10 17:45:21 UTC (rev 1589)
@@ -968,8 +968,8 @@
# The function name (must match exactly) [XX] not anymore!
r'(?P<func>\w+)' +
# The parameters
- r'\((?P<params>(\s*\[?\s*\*{0,2}[\w\-\.]+(=.+?)?'+
- r'(\s*\[?\s*,\s*\]?\s*\*{0,2}[\w\-\.]+(=.+?)?)*\]*)?)\s*\)' +
+ r'\((?P<params>(\s*\[?\s*\*{0,2}[\w\-\.]+(\s*=.+?)?'+
+ r'(\s*\[?\s*,\s*\]?\s*\*{0,2}[\w\-\.]+(\s*=.+?)?)*\]*)?)\s*\)' +
# The return value (optional)
r'(\s*(->)\s*(?P<return>\S.*?))?'+
# The end marker
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <dva...@us...> - 2007-03-25 13:37:16
|
Revision: 1588
http://svn.sourceforge.net/epydoc/?rev=1588&view=rev
Author: dvarrazzo
Date: 2007-03-25 06:37:13 -0700 (Sun, 25 Mar 2007)
Log Message:
-----------
- `init_sorted_variables()` really called.
Currently the docbuilder always calls it before, so this row is
actually never reached.
Modified Paths:
--------------
trunk/epydoc/src/epydoc/apidoc.py
Modified: trunk/epydoc/src/epydoc/apidoc.py
===================================================================
--- trunk/epydoc/src/epydoc/apidoc.py 2007-03-20 00:58:51 UTC (rev 1587)
+++ trunk/epydoc/src/epydoc/apidoc.py 2007-03-25 13:37:13 UTC (rev 1588)
@@ -1010,7 +1010,7 @@
L{sorted_variables} and L{group_specs} attributes.
"""
if self.sorted_variables is UNKNOWN:
- self.init_sorted_variables
+ self.init_sorted_variables()
assert len(self.sorted_variables) == len(self.variables)
elts = [(v.name, v) for v in self.sorted_variables]
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
