happydoc-discuss Mailing List for HappyDoc
Brought to you by:
doughellmann,
krlosaqp
You can subscribe to this list here.
2001 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
(2) |
Dec
|
---|---|---|---|---|---|---|---|---|---|---|---|---|
2002 |
Jan
(2) |
Feb
|
Mar
(5) |
Apr
|
May
(2) |
Jun
(1) |
Jul
|
Aug
|
Sep
|
Oct
(3) |
Nov
(2) |
Dec
(2) |
2005 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
(2) |
Sep
|
Oct
|
Nov
|
Dec
|
2006 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
(6) |
Dec
(7) |
From: Nitin S. <nit...@go...> - 2006-12-08 10:49:02
|
The new release works fine. There's no more trace back errors seen during execution. Thanks. Nitin On 12/5/06, Doug Hellmann <do...@he...> wrote: > > I posted version 3.1 of HappyDoc to the downloads area this morning. > This release still does not have a setup.py, but the syntax errors > should be resolved. If someone wants to submit a patch with a > setup.py file, I would be glad to receive it an integrate it with the > package. :-) > > Please give the new release a try and let me know if you have any > problems. > > Doug > > > On Dec 5, 2006, at 12:29 AM, Nitin Shukla wrote: > > > Hello Doug, > > > > Thank you for the information. > > > > Is there a plan for new release of happydoc in near future. If yes > > when can we expect it? > > > > I took the latest version of Happy Doc from the CVS repository > > yesterday. I ran happydoc and it did generate the html > > documentation but not without the following trace back errors > > thrown up. > > > > --- Plugin Module Error in happydoclib.docset.docset_TAL --- > > Traceback (most recent call last): > > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/ > > pluginloader.py", line 177, in __init__ > > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > > docset_TAL/__init__.py", line 66, in ? > > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > > docset_TAL/templateset.py", line 66, in ? > > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > > docset_TAL/templatefile.py", line 64, in ? > > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > > docset_TAL/hdExpressions.py", line 27, in ? > > SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line > > 282) > > --------------------------- > > > > I believe the None problem still persists. Can we expect this to be > > fixed before any release? > > > > Nitin > > > > > > On 12/1/06, Doug Hellmann < do...@he...> wrote:Hi, Nitin, > > > > The problem has to do with None being changed from a builtin to a > > keyword in a recent version of Python. The CVS version of HappyDoc > > corrects the problems, but I haven't had a chance to package up a new > > release yet. > > > > Doug > > > > > > On Dec 1, 2006, at 6:53 AM, Nitin Shukla wrote: > > > > > Hello, > > > > > > I downloaded the latest available version of happydoc 3.0 and > > > unpacked the tar file. Since there's not setup.py file I tried to > > > use the happydoc script directly from the extracted code. I get the > > > following errors when I do ../../../Desktop/HappyDoc3-r3_0_a1/ > > > happydoc pyDocSample.py > > > > > > > > > --- Plugin Module Error in > > > happydoclib.docstring.docstring_PlainText --- > > > Traceback (most recent call last): > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > pluginloader.py", line 177, in __init__ > > > _module = __import__( _import_name ) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/docstring_PlainText.py", line 66, in ? > > > import happydoclib.docstring.StructuredText > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/StructuredText/__init__.py", line 14, in ? > > > import HTMLClass, DocumentClass > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/StructuredText/HTMLClass.py", line 15, in ? > > > import re, sys, ST > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/StructuredText/ST.py", line 14, in ? > > > import re, STDOM > > > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > > > 343) > > > --------------------------- > > > > > > > > > --- Plugin Module Error in > > > happydoclib.docstring.docstring_StructuredText --- > > > Traceback (most recent call last): > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > pluginloader.py", line 177, in __init__ > > > _module = __import__( _import_name ) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/docstring_StructuredText.py", line 62, in ? > > > import happydoclib.docstring.StructuredText > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/StructuredText/__init__.py", line 14, in ? > > > import HTMLClass, DocumentClass > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/StructuredText/HTMLClass.py", line 15, in ? > > > import re, sys, ST > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/StructuredText/ST.py", line 14, in ? > > > import re, STDOM > > > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > > > 343) > > > --------------------------- > > > > > > > > > --- Plugin Module Error in happydoclib.docset.docset_TAL --- > > > Traceback (most recent call last): > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > pluginloader.py ", line 177, in __init__ > > > _module = __import__( _import_name ) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/docset_TAL/__init__.py", line 66, in ? > > > from happydoclib.docset.docset_TAL.templateset import > > TemplateSet > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/docset_TAL/templateset.py", line 66, in ? > > > from happydoclib.docset.docset_TAL.templatefile import > > > TemplateFile > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/docset_TAL/templatefile.py", line 64, in ? > > > from happydoclib.docset.docset_TAL import hdExpressions > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/docset_TAL/hdExpressions.py", line 27, in ? > > > from hdTALES import Engine, CompilerError, _valid_name, > > NAME_RE, \ > > > SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line > > > 282) > > > --------------------------- > > > > > > HappyDoc version 3.0.a1 > > > Scanning... > > > Parsing: pyDocSample.py > > > Done > > > Initializing documentation set HappyDoc Generated Documentation > > > NEED TO HANDLE extraParameters in DocSetBase > > > Writing... > > > Documenting: "pyDocSample.py" > > > to: "doc/pyDocSample.html" > > > Wanted: "StructuredText" > > > Have : ['RawText', 'ClassicStructuredText'] > > > Traceback (most recent call last): > > > File "../../../Desktop/HappyDoc3-r3_0_a1/happydoc", line 61, in ? > > > HappyDoc().run() > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > CommandLineApp.py", line 314, in run > > > exit_code = apply(self.main, tuple(self.remainingOpts )) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > appclass.py", line 492, in main > > > docset.write() > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/base.py", line 322, in write > > > self.scanner.walk(self.writeCB) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > scanner.py", line 227, in walk > > > tree.walk(callback) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > packagetree.py", line 443, in walk > > > callback(self) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/base.py", line 315, in writeCB > > > writer(packageTreeNode) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/docset_MultiHTMLFile.py", line 1076, in processPythonFile > > > self.writeText(output, readme_text, text_format) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/base.py", line 615, in writeText > > > html = self.formatText (text, textFormat) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docset/base.py", line 582, in formatText > > > converter_factory = getConverterFactory(textFormat) > > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > > docstring/__init__.py", line 183, in getConverterFactory > > > raise ValueError('Unrecognized docstring format type "%s"' % > > > formatType) > > > ValueError: Unrecognized docstring format type "StructuredText" > > > > > > > > > Can anyone help me identify what's going wrong here and help > > > generate documentation for the python code I have. > > > > > > Nitin > > > > > > > > ---------------------------------------------------------------------- > > > --- > > > Take Surveys. Earn Cash. Influence the Future of IT > > > Join SourceForge.net's Techsay panel and you'll get the chance to > > > share your > > > opinions on IT & business topics through brief surveys - and earn > > cash > > > http://www.techsay.com/default.php? > > > > > page=join.php&p=sourceforge&CID=DEVDEV________________________________ > > > _______________ > > > HappyDoc-discuss mailing list > > > Hap...@li... > > > https://lists.sourceforge.net/lists/listinfo/happydoc-discuss > > > > > > |
From: Doug H. <do...@he...> - 2006-12-05 13:41:09
|
I posted version 3.1 of HappyDoc to the downloads area this morning. This release still does not have a setup.py, but the syntax errors should be resolved. If someone wants to submit a patch with a setup.py file, I would be glad to receive it an integrate it with the package. :-) Please give the new release a try and let me know if you have any problems. Doug On Dec 5, 2006, at 12:29 AM, Nitin Shukla wrote: > Hello Doug, > > Thank you for the information. > > Is there a plan for new release of happydoc in near future. If yes > when can we expect it? > > I took the latest version of Happy Doc from the CVS repository > yesterday. I ran happydoc and it did generate the html > documentation but not without the following trace back errors > thrown up. > > --- Plugin Module Error in happydoclib.docset.docset_TAL --- > Traceback (most recent call last): > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/ > pluginloader.py", line 177, in __init__ > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > docset_TAL/__init__.py", line 66, in ? > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > docset_TAL/templateset.py", line 66, in ? > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > docset_TAL/templatefile.py", line 64, in ? > File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/ > docset_TAL/hdExpressions.py", line 27, in ? > SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line > 282) > --------------------------- > > I believe the None problem still persists. Can we expect this to be > fixed before any release? > > Nitin > > > On 12/1/06, Doug Hellmann < do...@he...> wrote:Hi, Nitin, > > The problem has to do with None being changed from a builtin to a > keyword in a recent version of Python. The CVS version of HappyDoc > corrects the problems, but I haven't had a chance to package up a new > release yet. > > Doug > > > On Dec 1, 2006, at 6:53 AM, Nitin Shukla wrote: > > > Hello, > > > > I downloaded the latest available version of happydoc 3.0 and > > unpacked the tar file. Since there's not setup.py file I tried to > > use the happydoc script directly from the extracted code. I get the > > following errors when I do ../../../Desktop/HappyDoc3-r3_0_a1/ > > happydoc pyDocSample.py > > > > > > --- Plugin Module Error in > > happydoclib.docstring.docstring_PlainText --- > > Traceback (most recent call last): > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > pluginloader.py", line 177, in __init__ > > _module = __import__( _import_name ) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/docstring_PlainText.py", line 66, in ? > > import happydoclib.docstring.StructuredText > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/__init__.py", line 14, in ? > > import HTMLClass, DocumentClass > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/HTMLClass.py", line 15, in ? > > import re, sys, ST > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/ST.py", line 14, in ? > > import re, STDOM > > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > > 343) > > --------------------------- > > > > > > --- Plugin Module Error in > > happydoclib.docstring.docstring_StructuredText --- > > Traceback (most recent call last): > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > pluginloader.py", line 177, in __init__ > > _module = __import__( _import_name ) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/docstring_StructuredText.py", line 62, in ? > > import happydoclib.docstring.StructuredText > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/__init__.py", line 14, in ? > > import HTMLClass, DocumentClass > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/HTMLClass.py", line 15, in ? > > import re, sys, ST > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/ST.py", line 14, in ? > > import re, STDOM > > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > > 343) > > --------------------------- > > > > > > --- Plugin Module Error in happydoclib.docset.docset_TAL --- > > Traceback (most recent call last): > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > pluginloader.py ", line 177, in __init__ > > _module = __import__( _import_name ) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/__init__.py", line 66, in ? > > from happydoclib.docset.docset_TAL.templateset import > TemplateSet > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/templateset.py", line 66, in ? > > from happydoclib.docset.docset_TAL.templatefile import > > TemplateFile > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/templatefile.py", line 64, in ? > > from happydoclib.docset.docset_TAL import hdExpressions > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/hdExpressions.py", line 27, in ? > > from hdTALES import Engine, CompilerError, _valid_name, > NAME_RE, \ > > SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line > > 282) > > --------------------------- > > > > HappyDoc version 3.0.a1 > > Scanning... > > Parsing: pyDocSample.py > > Done > > Initializing documentation set HappyDoc Generated Documentation > > NEED TO HANDLE extraParameters in DocSetBase > > Writing... > > Documenting: "pyDocSample.py" > > to: "doc/pyDocSample.html" > > Wanted: "StructuredText" > > Have : ['RawText', 'ClassicStructuredText'] > > Traceback (most recent call last): > > File "../../../Desktop/HappyDoc3-r3_0_a1/happydoc", line 61, in ? > > HappyDoc().run() > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > CommandLineApp.py", line 314, in run > > exit_code = apply(self.main, tuple(self.remainingOpts )) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > appclass.py", line 492, in main > > docset.write() > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 322, in write > > self.scanner.walk(self.writeCB) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > scanner.py", line 227, in walk > > tree.walk(callback) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > packagetree.py", line 443, in walk > > callback(self) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 315, in writeCB > > writer(packageTreeNode) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_MultiHTMLFile.py", line 1076, in processPythonFile > > self.writeText(output, readme_text, text_format) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 615, in writeText > > html = self.formatText (text, textFormat) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 582, in formatText > > converter_factory = getConverterFactory(textFormat) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/__init__.py", line 183, in getConverterFactory > > raise ValueError('Unrecognized docstring format type "%s"' % > > formatType) > > ValueError: Unrecognized docstring format type "StructuredText" > > > > > > Can anyone help me identify what's going wrong here and help > > generate documentation for the python code I have. > > > > Nitin > > > > > ---------------------------------------------------------------------- > > --- > > Take Surveys. Earn Cash. Influence the Future of IT > > Join SourceForge.net's Techsay panel and you'll get the chance to > > share your > > opinions on IT & business topics through brief surveys - and earn > cash > > http://www.techsay.com/default.php? > > > page=join.php&p=sourceforge&CID=DEVDEV________________________________ > > _______________ > > HappyDoc-discuss mailing list > > Hap...@li... > > https://lists.sourceforge.net/lists/listinfo/happydoc-discuss > > |
From: Nitin S. <nit...@go...> - 2006-12-05 05:29:22
|
Hello Doug, Thank you for the information. Is there a plan for new release of happydoc in near future. If yes when can we expect it? I took the latest version of Happy Doc from the CVS repository yesterday. I ran happydoc and it did generate the html documentation but not without the following trace back errors thrown up. --- Plugin Module Error in happydoclib.docset.docset_TAL --- Traceback (most recent call last): File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/pluginloader.py", line 177, in __init__ File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/docset_TAL/__init__.py", line 66, in ? File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/docset_TAL/templateset.py", line 66, in ? File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/docset_TAL/templatefile.py", line 64, in ? File "/home/nitinshukla/HappyDoc/HappyDoc3/happydoclib/docset/docset_TAL/hdExpressions.py", line 27, in ? SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line 282) --------------------------- I believe the None problem still persists. Can we expect this to be fixed before any release? Nitin On 12/1/06, Doug Hellmann <do...@he...> wrote: > > Hi, Nitin, > > The problem has to do with None being changed from a builtin to a > keyword in a recent version of Python. The CVS version of HappyDoc > corrects the problems, but I haven't had a chance to package up a new > release yet. > > Doug > > > On Dec 1, 2006, at 6:53 AM, Nitin Shukla wrote: > > > Hello, > > > > I downloaded the latest available version of happydoc 3.0 and > > unpacked the tar file. Since there's not setup.py file I tried to > > use the happydoc script directly from the extracted code. I get the > > following errors when I do ../../../Desktop/HappyDoc3-r3_0_a1/ > > happydoc pyDocSample.py > > > > > > --- Plugin Module Error in > > happydoclib.docstring.docstring_PlainText --- > > Traceback (most recent call last): > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > pluginloader.py", line 177, in __init__ > > _module = __import__( _import_name ) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/docstring_PlainText.py", line 66, in ? > > import happydoclib.docstring.StructuredText > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/__init__.py", line 14, in ? > > import HTMLClass, DocumentClass > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/HTMLClass.py", line 15, in ? > > import re, sys, ST > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/ST.py", line 14, in ? > > import re, STDOM > > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > > 343) > > --------------------------- > > > > > > --- Plugin Module Error in > > happydoclib.docstring.docstring_StructuredText --- > > Traceback (most recent call last): > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > pluginloader.py", line 177, in __init__ > > _module = __import__( _import_name ) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/docstring_StructuredText.py", line 62, in ? > > import happydoclib.docstring.StructuredText > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/__init__.py", line 14, in ? > > import HTMLClass, DocumentClass > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/HTMLClass.py", line 15, in ? > > import re, sys, ST > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/StructuredText/ST.py", line 14, in ? > > import re, STDOM > > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > > 343) > > --------------------------- > > > > > > --- Plugin Module Error in happydoclib.docset.docset_TAL --- > > Traceback (most recent call last): > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > pluginloader.py", line 177, in __init__ > > _module = __import__( _import_name ) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/__init__.py", line 66, in ? > > from happydoclib.docset.docset_TAL.templateset import TemplateSet > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/templateset.py", line 66, in ? > > from happydoclib.docset.docset_TAL.templatefile import > > TemplateFile > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/templatefile.py", line 64, in ? > > from happydoclib.docset.docset_TAL import hdExpressions > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_TAL/hdExpressions.py", line 27, in ? > > from hdTALES import Engine, CompilerError, _valid_name, NAME_RE, \ > > SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line > > 282) > > --------------------------- > > > > HappyDoc version 3.0.a1 > > Scanning... > > Parsing: pyDocSample.py > > Done > > Initializing documentation set HappyDoc Generated Documentation > > NEED TO HANDLE extraParameters in DocSetBase > > Writing... > > Documenting: "pyDocSample.py" > > to: "doc/pyDocSample.html" > > Wanted: "StructuredText" > > Have : ['RawText', 'ClassicStructuredText'] > > Traceback (most recent call last): > > File "../../../Desktop/HappyDoc3-r3_0_a1/happydoc", line 61, in ? > > HappyDoc().run() > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > CommandLineApp.py", line 314, in run > > exit_code = apply(self.main, tuple(self.remainingOpts)) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > appclass.py", line 492, in main > > docset.write() > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 322, in write > > self.scanner.walk(self.writeCB) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > scanner.py", line 227, in walk > > tree.walk(callback) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > packagetree.py", line 443, in walk > > callback(self) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 315, in writeCB > > writer(packageTreeNode) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/docset_MultiHTMLFile.py", line 1076, in processPythonFile > > self.writeText(output, readme_text, text_format) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 615, in writeText > > html = self.formatText(text, textFormat) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docset/base.py", line 582, in formatText > > converter_factory = getConverterFactory(textFormat) > > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > > docstring/__init__.py", line 183, in getConverterFactory > > raise ValueError('Unrecognized docstring format type "%s"' % > > formatType) > > ValueError: Unrecognized docstring format type "StructuredText" > > > > > > Can anyone help me identify what's going wrong here and help > > generate documentation for the python code I have. > > > > Nitin > > > > ---------------------------------------------------------------------- > > --- > > Take Surveys. Earn Cash. Influence the Future of IT > > Join SourceForge.net's Techsay panel and you'll get the chance to > > share your > > opinions on IT & business topics through brief surveys - and earn cash > > http://www.techsay.com/default.php? > > page=join.php&p=sourceforge&CID=DEVDEV________________________________ > > _______________ > > HappyDoc-discuss mailing list > > Hap...@li... > > https://lists.sourceforge.net/lists/listinfo/happydoc-discuss > > |
From: Doug H. <do...@he...> - 2006-12-01 16:02:41
|
Can you send a copy of your source file that causes the error? Doug On Dec 1, 2006, at 10:41 AM, Antonios Katsikadamos wrote: > Hi all sorry to bother again. I am running happydoc 3.0 and i met > this error while scanning python code > > File "/root/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/ > __init__.py", line 183, in getConverterFactory > raise ValueError('Unrecognized docstring format type "%s"' % > formatType) > ValueError: Unrecognized docstring format type "StructuredText" > > > or using happydoc2.0 this error > > File "/root/Desktop/HappyDoc-r2_0/happydoclib/docstring/ > __init__.py", line 183, in getConverterFactory > raise ValueError('Unrecognized docstring format type "%s"' % > formatType) > ValueError: Unrecognized docstring format type "PlainText" > > > And i don't know how to overcome them. > > I would appreciate any help. > > Kind regards, > > Antonios > > Everyone is raving about the all-new Yahoo! Mail beta. > ---------------------------------------------------------------------- > --- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to > share your > opinions on IT & business topics through brief surveys - and earn cash > http://www.techsay.com/default.php? > page=join.php&p=sourceforge&CID=DEVDEV________________________________ > _______________ > HappyDoc-discuss mailing list > Hap...@li... > https://lists.sourceforge.net/lists/listinfo/happydoc-discuss |
From: Antonios K. <ant...@ya...> - 2006-12-01 15:41:46
|
Hi all sorry to bother again. I am running happydoc 3.0 and i met this error while scanning python code File "/root/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/__init__.py", line 183, in getConverterFactory raise ValueError('Unrecognized docstring format type "%s"' % formatType) ValueError: Unrecognized docstring format type "StructuredText" or using happydoc2.0 this error File "/root/Desktop/HappyDoc-r2_0/happydoclib/docstring/__init__.py", line 183, in getConverterFactory raise ValueError('Unrecognized docstring format type "%s"' % formatType) ValueError: Unrecognized docstring format type "PlainText" And i don't know how to overcome them. I would appreciate any help. Kind regards, Antonios --------------------------------- Everyone is raving about the all-new Yahoo! Mail beta. |
From: Doug H. <do...@he...> - 2006-12-01 12:03:39
|
Hi, Nitin, The problem has to do with None being changed from a builtin to a keyword in a recent version of Python. The CVS version of HappyDoc corrects the problems, but I haven't had a chance to package up a new release yet. Doug On Dec 1, 2006, at 6:53 AM, Nitin Shukla wrote: > Hello, > > I downloaded the latest available version of happydoc 3.0 and > unpacked the tar file. Since there's not setup.py file I tried to > use the happydoc script directly from the extracted code. I get the > following errors when I do ../../../Desktop/HappyDoc3-r3_0_a1/ > happydoc pyDocSample.py > > > --- Plugin Module Error in > happydoclib.docstring.docstring_PlainText --- > Traceback (most recent call last): > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > pluginloader.py", line 177, in __init__ > _module = __import__( _import_name ) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/docstring_PlainText.py", line 66, in ? > import happydoclib.docstring.StructuredText > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/StructuredText/__init__.py", line 14, in ? > import HTMLClass, DocumentClass > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/StructuredText/HTMLClass.py", line 15, in ? > import re, sys, ST > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/StructuredText/ST.py", line 14, in ? > import re, STDOM > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > 343) > --------------------------- > > > --- Plugin Module Error in > happydoclib.docstring.docstring_StructuredText --- > Traceback (most recent call last): > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > pluginloader.py", line 177, in __init__ > _module = __import__( _import_name ) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/docstring_StructuredText.py", line 62, in ? > import happydoclib.docstring.StructuredText > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/StructuredText/__init__.py", line 14, in ? > import HTMLClass, DocumentClass > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/StructuredText/HTMLClass.py", line 15, in ? > import re, sys, ST > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/StructuredText/ST.py", line 14, in ? > import re, STDOM > SyntaxError: Invalid syntax. Assignment to None. ( STDOM.py, line > 343) > --------------------------- > > > --- Plugin Module Error in happydoclib.docset.docset_TAL --- > Traceback (most recent call last): > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > pluginloader.py", line 177, in __init__ > _module = __import__( _import_name ) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/docset_TAL/__init__.py", line 66, in ? > from happydoclib.docset.docset_TAL.templateset import TemplateSet > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/docset_TAL/templateset.py", line 66, in ? > from happydoclib.docset.docset_TAL.templatefile import > TemplateFile > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/docset_TAL/templatefile.py", line 64, in ? > from happydoclib.docset.docset_TAL import hdExpressions > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/docset_TAL/hdExpressions.py", line 27, in ? > from hdTALES import Engine, CompilerError, _valid_name, NAME_RE, \ > SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line > 282) > --------------------------- > > HappyDoc version 3.0.a1 > Scanning... > Parsing: pyDocSample.py > Done > Initializing documentation set HappyDoc Generated Documentation > NEED TO HANDLE extraParameters in DocSetBase > Writing... > Documenting: "pyDocSample.py" > to: "doc/pyDocSample.html" > Wanted: "StructuredText" > Have : ['RawText', 'ClassicStructuredText'] > Traceback (most recent call last): > File "../../../Desktop/HappyDoc3-r3_0_a1/happydoc", line 61, in ? > HappyDoc().run() > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > CommandLineApp.py", line 314, in run > exit_code = apply(self.main, tuple(self.remainingOpts)) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > appclass.py", line 492, in main > docset.write() > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/base.py", line 322, in write > self.scanner.walk(self.writeCB) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > scanner.py", line 227, in walk > tree.walk(callback) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > packagetree.py", line 443, in walk > callback(self) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/base.py", line 315, in writeCB > writer(packageTreeNode) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/docset_MultiHTMLFile.py", line 1076, in processPythonFile > self.writeText(output, readme_text, text_format) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/base.py", line 615, in writeText > html = self.formatText(text, textFormat) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docset/base.py", line 582, in formatText > converter_factory = getConverterFactory(textFormat) > File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/ > docstring/__init__.py", line 183, in getConverterFactory > raise ValueError('Unrecognized docstring format type "%s"' % > formatType) > ValueError: Unrecognized docstring format type "StructuredText" > > > Can anyone help me identify what's going wrong here and help > generate documentation for the python code I have. > > Nitin > > ---------------------------------------------------------------------- > --- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to > share your > opinions on IT & business topics through brief surveys - and earn cash > http://www.techsay.com/default.php? > page=join.php&p=sourceforge&CID=DEVDEV________________________________ > _______________ > HappyDoc-discuss mailing list > Hap...@li... > https://lists.sourceforge.net/lists/listinfo/happydoc-discuss |
From: Nitin S. <nit...@go...> - 2006-12-01 11:53:30
|
Hello, I downloaded the latest available version of happydoc 3.0 and unpacked the tar file. Since there's not setup.py file I tried to use the happydoc script directly from the extracted code. I get the following errors when I do ../../../Desktop/HappyDoc3-r3_0_a1/happydoc pyDocSample.py --- Plugin Module Error in happydoclib.docstring.docstring_PlainText --- Traceback (most recent call last): File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/pluginloader.py", line 177, in __init__ _module = __import__( _import_name ) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/docstring_PlainText.py", line 66, in ? import happydoclib.docstring.StructuredText File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/StructuredText/__init__.py", line 14, in ? import HTMLClass, DocumentClass File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/StructuredText/HTMLClass.py", line 15, in ? import re, sys, ST File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/StructuredText/ST.py", line 14, in ? import re, STDOM SyntaxError: Invalid syntax. Assignment to None. (STDOM.py, line 343) --------------------------- --- Plugin Module Error in happydoclib.docstring.docstring_StructuredText--- Traceback (most recent call last): File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/pluginloader.py", line 177, in __init__ _module = __import__( _import_name ) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/docstring_StructuredText.py", line 62, in ? import happydoclib.docstring.StructuredText File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/StructuredText/__init__.py", line 14, in ? import HTMLClass, DocumentClass File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/StructuredText/HTMLClass.py", line 15, in ? import re, sys, ST File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/StructuredText/ST.py", line 14, in ? import re, STDOM SyntaxError: Invalid syntax. Assignment to None. (STDOM.py, line 343) --------------------------- --- Plugin Module Error in happydoclib.docset.docset_TAL --- Traceback (most recent call last): File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/pluginloader.py", line 177, in __init__ _module = __import__( _import_name ) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/docset_TAL/__init__.py", line 66, in ? from happydoclib.docset.docset_TAL.templateset import TemplateSet File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/docset_TAL/templateset.py", line 66, in ? from happydoclib.docset.docset_TAL.templatefile import TemplateFile File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/docset_TAL/templatefile.py", line 64, in ? from happydoclib.docset.docset_TAL import hdExpressions File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/docset_TAL/hdExpressions.py", line 27, in ? from hdTALES import Engine, CompilerError, _valid_name, NAME_RE, \ SyntaxError: Invalid syntax. Assignment to None. (hdTALES.py, line 282) --------------------------- HappyDoc version 3.0.a1 Scanning... Parsing: pyDocSample.py Done Initializing documentation set HappyDoc Generated Documentation NEED TO HANDLE extraParameters in DocSetBase Writing... Documenting: "pyDocSample.py" to: "doc/pyDocSample.html" Wanted: "StructuredText" Have : ['RawText', 'ClassicStructuredText'] Traceback (most recent call last): File "../../../Desktop/HappyDoc3-r3_0_a1/happydoc", line 61, in ? HappyDoc().run() File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/CommandLineApp.py", line 314, in run exit_code = apply(self.main, tuple(self.remainingOpts)) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/appclass.py", line 492, in main docset.write() File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/base.py", line 322, in write self.scanner.walk(self.writeCB) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/scanner.py", line 227, in walk tree.walk(callback) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/packagetree.py", line 443, in walk callback(self) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/base.py", line 315, in writeCB writer(packageTreeNode) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/docset_MultiHTMLFile.py", line 1076, in processPythonFile self.writeText(output, readme_text, text_format) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/base.py", line 615, in writeText html = self.formatText(text, textFormat) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docset/base.py", line 582, in formatText converter_factory = getConverterFactory(textFormat) File "/home/nitinshukla/Desktop/HappyDoc3-r3_0_a1/happydoclib/docstring/__init__.py", line 183, in getConverterFactory raise ValueError('Unrecognized docstring format type "%s"' % formatType) ValueError: Unrecognized docstring format type "StructuredText" Can anyone help me identify what's going wrong here and help generate documentation for the python code I have. Nitin |
From: Doug H. <do...@he...> - 2006-11-30 16:16:49
|
Just run the happydoc script that is in the directory created when you unpack the tarball. That script will find the libraries it needs in the same directory. Doug On Nov 30, 2006, at 11:12 AM, Antonios Katsikadamos wrote: > > > Doug Hellmann <do...@he...> wrote: Give 3.0 version a try -- > it has much better support for different > input/output formats. Extract the tarball and run it from that > directory (it doesn't need to be installed to work). > > Doug > > > > > > Hi and sorry again to bother. I wanted to ask. How can i run it > from the extracted file without installing it? > > > Kind regards, > > Antonios > > > Check out the all-new Yahoo! Mail beta - Fire up a more powerful > email and get things done faster. |
From: Antonios K. <ant...@ya...> - 2006-11-30 16:13:05
|
Doug Hellmann <do...@he...> wrote: Give 3.0 version a try -- it has much better support for different input/output formats. Extract the tarball and run it from that directory (it doesn't need to be installed to work). Doug Hi and sorry again to bother. I wanted to ask. How can i run it from the extracted file without installing it? Kind regards, Antonios --------------------------------- Check out the all-new Yahoo! Mail beta - Fire up a more powerful email and get things done faster. |
From: Doug H. <do...@he...> - 2006-11-30 15:15:20
|
Give 3.0 version a try -- it has much better support for different input/output formats. Extract the tarball and run it from that directory (it doesn't need to be installed to work). Doug On Nov 30, 2006, at 9:58 AM, Antonios Katsikadamos wrote: > > > Doug Hellmann <do...@he...> wrote: Hi, Antonios, > > It sounds like there was a problem with the installation of > happydoc. That error appears to be saying that it cannot find the > "docstring parser" module for a plaintext docstring. The parser is > in a plugin module that should have been installed with the rest of > the code. > > What version of happydoc are you using? > > Doug > > > On Nov 30, 2006, at 9:26 AM, Antonios Katsikadamos wrote: > > > Hi all. I have a problem. When i try to produce doc from a code i > > encountered the following error message > > > > File "/usr/local/bin/happydoc", line 61, in ? > > HappyDoc().run() > > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > > CommandLineApp.py", line 315, in run > > exit_code = apply(self.main, tuple(self.remainingOpts)) > > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > > appclass.py", line 433, in main > > parsed_modules.write() > > File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/ > > docset_MultipleFile.py", line 114, in write > > self._writeDescription( self._root_node ) > > File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/ > > docset_MultipleFile.py", line 137, in _writeDescription > > description, input_type = self.getDescriptionAndFormat() > > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > > happydocset.py", line 466, in getDescriptionAndFormat > > description_file = self.getExternalDocumentationFile > > (description_filename) > > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > > happydocset.py", line 384, in getExternalDocumentationFile > > converter_factory = > > happydoclib.docstring.getConverterFactoryForFile(filename) > > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > > docstring/__init__.py", line 199, in getConverterFactoryForFile > > return getConverterFactory(converter_name) > > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > > docstring/__init__.py", line 183, in getConverterFactory > > raise ValueError('Unrecognized docstring format type "%s"' % > > formatType) > > > > > > ValueError: Unrecognized docstring format type "PlainText" > > > > > > > > > > Doea anyone know what it is? > > > > > > thnxs for any help > > > > Antonios > > > > > >I am using the 2.1 version on suse linux. I downloaded the 3.0 but > there was no setup.py in it to do the installation. so i downloaded > the 2.1 > > > Kind regards, > > Antonios > > Check out the all-new Yahoo! Mail beta - Fire up a more powerful > email and get things done faster. |
From: Antonios K. <ant...@ya...> - 2006-11-30 14:58:45
|
Doug Hellmann <do...@he...> wrote: Hi, Antonios, It sounds like there was a problem with the installation of happydoc. That error appears to be saying that it cannot find the "docstring parser" module for a plaintext docstring. The parser is in a plugin module that should have been installed with the rest of the code. What version of happydoc are you using? Doug On Nov 30, 2006, at 9:26 AM, Antonios Katsikadamos wrote: > Hi all. I have a problem. When i try to produce doc from a code i > encountered the following error message > > File "/usr/local/bin/happydoc", line 61, in ? > HappyDoc().run() > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > CommandLineApp.py", line 315, in run > exit_code = apply(self.main, tuple(self.remainingOpts)) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > appclass.py", line 433, in main > parsed_modules.write() > File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/ > docset_MultipleFile.py", line 114, in write > self._writeDescription( self._root_node ) > File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/ > docset_MultipleFile.py", line 137, in _writeDescription > description, input_type = self.getDescriptionAndFormat() > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > happydocset.py", line 466, in getDescriptionAndFormat > description_file = self.getExternalDocumentationFile > (description_filename) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > happydocset.py", line 384, in getExternalDocumentationFile > converter_factory = > happydoclib.docstring.getConverterFactoryForFile(filename) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > docstring/__init__.py", line 199, in getConverterFactoryForFile > return getConverterFactory(converter_name) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > docstring/__init__.py", line 183, in getConverterFactory > raise ValueError('Unrecognized docstring format type "%s"' % > formatType) > > > ValueError: Unrecognized docstring format type "PlainText" > > > > > Doea anyone know what it is? > > > thnxs for any help > > Antonios > > >I am using the 2.1 version on suse linux. I downloaded the 3.0 but there was no setup.py in it to do the installation. so i downloaded the 2.1 Kind regards, Antonios --------------------------------- Check out the all-new Yahoo! Mail beta - Fire up a more powerful email and get things done faster. |
From: Doug H. <do...@he...> - 2006-11-30 14:43:59
|
Hi, Antonios, It sounds like there was a problem with the installation of happydoc. That error appears to be saying that it cannot find the "docstring parser" module for a plaintext docstring. The parser is in a plugin module that should have been installed with the rest of the code. What version of happydoc are you using? Doug On Nov 30, 2006, at 9:26 AM, Antonios Katsikadamos wrote: > Hi all. I have a problem. When i try to produce doc from a code i > encountered the following error message > > File "/usr/local/bin/happydoc", line 61, in ? > HappyDoc().run() > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > CommandLineApp.py", line 315, in run > exit_code = apply(self.main, tuple(self.remainingOpts)) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > appclass.py", line 433, in main > parsed_modules.write() > File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/ > docset_MultipleFile.py", line 114, in write > self._writeDescription( self._root_node ) > File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/ > docset_MultipleFile.py", line 137, in _writeDescription > description, input_type = self.getDescriptionAndFormat() > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > happydocset.py", line 466, in getDescriptionAndFormat > description_file = self.getExternalDocumentationFile > (description_filename) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > happydocset.py", line 384, in getExternalDocumentationFile > converter_factory = > happydoclib.docstring.getConverterFactoryForFile(filename) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > docstring/__init__.py", line 199, in getConverterFactoryForFile > return getConverterFactory(converter_name) > File "/usr/local/lib/python2.4/site-packages/happydoclib/ > docstring/__init__.py", line 183, in getConverterFactory > raise ValueError('Unrecognized docstring format type "%s"' % > formatType) > > > ValueError: Unrecognized docstring format type "PlainText" > > > > > Doea anyone know what it is? > > > thnxs for any help > > Antonios > > > Everyone is raving about the all-new Yahoo! Mail beta. > ---------------------------------------------------------------------- > --- > Take Surveys. Earn Cash. Influence the Future of IT > Join SourceForge.net's Techsay panel and you'll get the chance to > share your > opinions on IT & business topics through brief surveys - and earn cash > http://www.techsay.com/default.php? > page=join.php&p=sourceforge&CID=DEVDEV________________________________ > _______________ > HappyDoc-discuss mailing list > Hap...@li... > https://lists.sourceforge.net/lists/listinfo/happydoc-discuss |
From: Antonios K. <ant...@ya...> - 2006-11-30 14:26:54
|
Hi all. I have a problem. When i try to produce doc from a code i encountered the following error message File "/usr/local/bin/happydoc", line 61, in ? HappyDoc().run() File "/usr/local/lib/python2.4/site-packages/happydoclib/CommandLineApp.py", line 315, in run exit_code = apply(self.main, tuple(self.remainingOpts)) File "/usr/local/lib/python2.4/site-packages/happydoclib/appclass.py", line 433, in main parsed_modules.write() File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/docset_MultipleFile.py", line 114, in write self._writeDescription( self._root_node ) File "/usr/local/lib/python2.4/site-packages/happydoclib/docset/docset_MultipleFile.py", line 137, in _writeDescription description, input_type = self.getDescriptionAndFormat() File "/usr/local/lib/python2.4/site-packages/happydoclib/happydocset.py", line 466, in getDescriptionAndFormat description_file = self.getExternalDocumentationFile(description_filename) File "/usr/local/lib/python2.4/site-packages/happydoclib/happydocset.py", line 384, in getExternalDocumentationFile converter_factory = happydoclib.docstring.getConverterFactoryForFile(filename) File "/usr/local/lib/python2.4/site-packages/happydoclib/docstring/__init__.py", line 199, in getConverterFactoryForFile return getConverterFactory(converter_name) File "/usr/local/lib/python2.4/site-packages/happydoclib/docstring/__init__.py", line 183, in getConverterFactory raise ValueError('Unrecognized docstring format type "%s"' % formatType) ValueError: Unrecognized docstring format type "PlainText" Doea anyone know what it is? thnxs for any help Antonios --------------------------------- Everyone is raving about the all-new Yahoo! Mail beta. |
From: Doug H. <do...@he...> - 2005-08-27 11:46:22
|
On Aug 25, 2005, at 12:55 PM, Donnal Walter wrote: > Sorry to be so dense, but I downloaded > HappyDoc_r3_0_a1.tar.gz > > and extracted it with WinZip, but I can't find a setup.py file. Hi, Donnal, Yes, this has been reported before. The 3.0.a1 release is an alpha, and wasn't packaged entirely properly. You can run happydoc directly from the extracted tarball, though, so you don't actually need the setup.py to give it a try. Doug |
From: Donnal W. <don...@ya...> - 2005-08-25 16:55:37
|
Sorry to be so dense, but I downloaded HappyDoc_r3_0_a1.tar.gz and extracted it with WinZip, but I can't find a setup.py file. Thanks, Donnal Walter Arkansas Children's Hospital |
From: Doug H. <do...@he...> - 2002-12-23 23:58:40
|
On Monday 23 December 2002 4:19 pm, Magos=E1nyi =C1rp=E1d wrote: > Hi! > > I am writing a Latex formatter for happydoc. It is now functional, > utilizes the hyperref latex package, so able to create nice crossrefere= nced Great! > pdf documentation, but the code is not very well thought-out. > I have some question regarding the design of happydoc. > > My main problem while writing the formatter was that the formatter > gets only syntactic (as opposed to semantic) information from the > docset code. What I have done is that I have invented some new > methods of the formatter class: > beginModule > endModule > beginClass > endClass > beginFunction > endFunction > beginClassesofMod > endClassesofMod > beginFuncsofMod > endFuncsofMod > beginImports > endImports > noImports > getStructuredLabel > getStructuredReference > > Before I did this, I made a short attempt to utilize the xml formatter > base, but that (at least in my copy which is the debian package > python-happydoc 2.0-2) was unuseable. And anyway, I guess the problem l= ays One of the XML formatters does have serious problems. I think I changed = some=20 APIs and the formatter author hasn't caught up yet, so it is my fault. > deeper: I think that the interface between the docset code and the > formatter code is not the best. I couldn't agree more. I have a couple of pernicious bugs related to whe= re=20 files are written, how they are named, building cross references, etc. =20 Basically the same list you cite as problems in the work you were doing. > My proposal is that the docset code should be concerned solely with the > structure of the document: "where the parts of the documentation > reside in the disc and within the document?", and the formatter be > responsible for the actual format of the parts of the document. For thi= s, I'm currently working on HappyDoc 3.0, which is going to be a complete=20 re-write to solve some of these design problems as well as add some new=20 features. The biggest change is that the docset and formatter plugins ar= e=20 merged into a single plugin. The idea that the docsets and formatters co= uld=20 be mixed and matched turned out to be less feasible than I originally=20 thought. There were several cases where both a docset and a formatter ne= eded=20 to be written, and there was a 1:1 mapping between them (OpenOffice, PDF,= =20 etc.). So, the docset is used by HappyDoc 3.0 through the "write()" method, and = that=20 is the only API required for the application. Everything else is handled= =20 inside the docset itself. I am going to provide base classes for the doc= set=20 for single and multiple files on the file system, to simplify the work of= =20 development. There will be an API similar to what you have laid out. Th= e=20 author of a new docset could either choose to override those methods to=20 provide output in a different format, or they can create docset plugins=20 without subclassing as long as their class has a write() method. > the docset should call methods of the formatter which refer to the > structure, and not to the syntax of the document, and should pass the > objects, not some names of them. (It made me some hard minutes to figur= e > out where the reference to a module gets "Module: " prepended to it, an= d > some hard hours to come up with a consistent method for cross-referenci= ng.) > > I have created a MultipleFileX and a SingleFileX docset which calls the > above-mentioned methods of the formatter, and of course the Latex forma= tter > uses these methods. Now the old formatter methods are also called from = the > docsets. The question is: how to do the transition? I can think of two > ways: > > way #1: use the new docsets for new formatters, and the old ones for ol= d > formatters. pros: > the transition can be done smoothly > cons: > the user should know which docset works with which formatter > > way #2: rewrite all formatters to use the new docsets > pros: > transition is fast, and the user cannot see it > cons: > lotsa code should be reworked, the probability of bugs is high > > way #3: make the new docsets recognise the "version" of the formatter, > and call the old formatters in the old way, the new ones in the new wa= y > > pros: > smooth transition, the user cannot see it > cons: > the docset code will be unnecessarily complex > > > Which way to go? There's not much point in modifying any of the existing docsets/formatter= s=20 since 3.0 is already in the works. I would go with option #1. The user = will=20 only need to worry about which formatters and docsets work together for a= =20 short time, assuming I can spend some time over the holiday working on 3.= 0. =20 :-) > I have some additional questions: > > -How to submit my code? (It needs to be reworked because the above > problems, but works now, and release early, release often) The easiest way initially would be to submit patches via SourceForge. If= =20 you're interested, we could also talk about you having CVS access. Do yo= u=20 have a SourceForge user account? > -I am just starting to convert the structuredtext docstrings to latex. > Where is the most efficient to start it? I would take a look at the existing code that converts to HTML. That is = in=20 the happydoclib/docstring/StructuredText package somewhere (don't remembe= r of=20 the top of my head - look at the docstring converter plugin for clues). Doug |
From: <ma...@bu...> - 2002-12-23 21:19:36
|
Hi! I am writing a Latex formatter for happydoc. It is now functional, utilizes the hyperref latex package, so able to create nice crossreferenced pdf documentation, but the code is not very well thought-out. I have some question regarding the design of happydoc. My main problem while writing the formatter was that the formatter gets only syntactic (as opposed to semantic) information from the docset code. What I have done is that I have invented some new methods of the formatter class: beginModule endModule beginClass endClass beginFunction endFunction beginClassesofMod endClassesofMod beginFuncsofMod endFuncsofMod beginImports endImports noImports getStructuredLabel getStructuredReference Before I did this, I made a short attempt to utilize the xml formatter base, but that (at least in my copy which is the debian package=20 python-happydoc 2.0-2) was unuseable. And anyway, I guess the problem lays deeper: I think that the interface between the docset code and the formatter code is not the best. My proposal is that the docset code should be concerned solely with the structure of the document: "where the parts of the documentation reside in the disc and within the document?", and the formatter be responsi= ble for the actual format of the parts of the document. For this, the docset should call methods of the formatter which refer to the structure, and not to the syntax of the document, and should pass the objects, not some names of them. (It made me some hard minutes to figure out where the refere= nce to a module gets "Module: " prepended to it, and some hard hours to come up with a consistent method for cross-referencing.) I have created a MultipleFileX and a SingleFileX docset which calls the above-mentioned methods of the formatter, and of course the Latex formatter uses these methods. Now the old formatter methods are also called from the docsets. The question is: how to do the transition? I can think of two ways: way #1: use the new docsets for new formatters, and the old ones for old fo= rmatters. pros: the transition can be done smoothly cons: the user should know which docset works with which formatter way #2: rewrite all formatters to use the new docsets pros: transition is fast, and the user cannot see it cons: lotsa code should be reworked, the probability of bugs is high way #3: make the new docsets recognise the "version" of the formatter, and call the old formatters in the old way, the new ones in the new way pros: smooth transition, the user cannot see it cons: the docset code will be unnecessarily complex Which way to go? I have some additional questions: -How to submit my code? (It needs to be reworked because the above problems, but works now, and release early, release often) -I am just starting to convert the structuredtext docstrings to latex. Where is the most efficient to start it? --=20 GNU GPL: csak tiszta forr=E1sb=F3l |
From: Doug H. <do...@he...> - 2002-11-25 16:08:37
|
Hi, Susie, Sorry for the late reply - this got lost in my various inboxes because of a filter misconfiguration. On Thursday 07 November 2002 10:32 pm, Susie wrote: > I have been experimenting with various Python documentation tools. I'd > like to document the Module Name and some commented text at the beginning > of the file, and hopefully in some readable format. Is there some > parameter on happydoc that I'm missing, which would include the starting > comments? But I really don't need all the other info about the module > (defs, etc.), so is there a simpler tool to use? HappyDoc should be extracting the comments already. Can you send example inputs and outputs? > What was happydoc originally designed for? How about similar documentation > tools, like pydoc, pythondoc, docutils... I guess that if I understand > what the original purpose was, I might have a better sense of what would be > best for my needs... The original purpose was to document libraries of Python code to produce reference manuals for their use by other programmers. I had one such library at the time, and did not want to have to keep up with the documentation separately from the source code. One of the tools you left off of your list was epydoc. I haven't looked at this one yet, but it might be of interest to you. As far as I know, none of the other tools which parse Python code look at the comments for documentation. I have not made an exhaustive study of the tools, though. Doug |
From: Susie <sus...@ya...> - 2002-11-08 03:32:38
|
I have been experimenting with various Python documentation tools. I'd like to document the Module Name and some commented text at the beginning of the file, and hopefully in some readable format. Is there some parameter on happydoc that I'm missing, which would include the starting comments? But I really don't need all the other info about the module (defs, etc.), so is there a simpler tool to use? What was happydoc originally designed for? How about similar documentation tools, like pydoc, pythondoc, docutils... I guess that if I understand what the original purpose was, I might have a better sense of what would be best for my needs... thank you! Susie --------------------------------- Do you Yahoo!? U2 on LAUNCH - Exclusive medley & videos from Greatest Hits CD |
From: Andy M. <an...@ag...> - 2002-10-18 14:46:22
|
> Version 2.1 was supposed to have fixed this problem. I have made some > further changes which I haven't checked in, but which may also help with the > situation. I can send you a tarball with the updated files, if you have some > time and could help test them. Yeah thats what I thought. I could be doing something wrong, it wont be the first time ;) Sure I'll happily test a new tarball. > I was planning to work on it some more this weekend, but it looks like it is > going to be dry enough to paint the house, so I'll probably be working on > that instead. Nah you can find something more interesting than this to do surely? -- Andy McKay www.agmweb.ca |
From: Doug H. <do...@he...> - 2002-10-18 12:31:59
|
On Thursday 17 October 2002 12:26 pm, Andy McKay wrote: > When I try build happydoc for a module eg: > > happydocwin.py -d e:\hdoc e:\cvs\CMFPlone\NavigationTool.py > > It happily puts all the docs in e:\hdoc as it should. However when I do > > happydocwin.py -d e:\hdoc e:\cvs\CMFPlone > > It seems to revert to the old behaviour, puts the index in hdoc and the > rest in CMFPlone, with all the usual problems that entails. > > Happydoc 2.1, Python 2.1.3, Win 2K Hi, Andy, Version 2.1 was supposed to have fixed this problem. I have made some further changes which I haven't checked in, but which may also help with the situation. I can send you a tarball with the updated files, if you have some time and could help test them. I was planning to work on it some more this weekend, but it looks like it is going to be dry enough to paint the house, so I'll probably be working on that instead. Doug |
From: Andy M. <an...@ag...> - 2002-10-17 16:23:58
|
When I try build happydoc for a module eg: happydocwin.py -d e:\hdoc e:\cvs\CMFPlone\NavigationTool.py It happily puts all the docs in e:\hdoc as it should. However when I do happydocwin.py -d e:\hdoc e:\cvs\CMFPlone It seems to revert to the old behaviour, puts the index in hdoc and the rest in CMFPlone, with all the usual problems that entails. Happydoc 2.1, Python 2.1.3, Win 2K Thanks -- Andy McKay www.agmweb.ca |
From: Greg C. <gre...@ya...> - 2002-06-05 01:47:28
|
I downloaded the latest code: HappyDoc_dos_path_bug_01.tar.gz and its working much better on NT. The only problem I have is when it deals with .txt files, the .txt.html files never get moved. I do use full path names with C: and all the other files get moved ok and linked properly but not the .txt files. Links to the .txt.html files point to directory where the .txt are not where the .txt.html should be. Also running HappyDoc twice creates .txt.html.html files out of the .txt.html files which look really bizzare. Thanks --Greg __________________________________________________ Do You Yahoo!? Yahoo! - Official partner of 2002 FIFA World Cup http://fifaworldcup.yahoo.com |
From: Doug H. <do...@he...> - 2002-05-20 15:43:13
|
On Monday 20 May 2002 10:57, Aaron Held wrote: > We have been testing out happyDoc to use against the source for > Webware.sourceforge.net and its great so far. > > Currently the project comes with a simple source based documentation that > just writes our the pages as html. Is there a way to map the classes and > methods in the HappyDoc output to the actual source pages. (In the highly > unlikely event that some methods are not documented?) Do you just want to add a link in the pages HappyDoc produces that points to the external source? You could add a StructuredText link in the docstring at the top of each module that would point to the "right place" (probably using relative links, but maybe it would be easier to start all of the links at /). I don't think there's any way to do it more automatically. You might be able to add the feature by subclassing the default docset implementation to provide your own custom version. If you decide to do that, you may be able to build a link at the point where the filename is written into the page header. > HappyDocs at webware.metrony.com for now. I poked around a bit, but wasn't able to find them. Are they already online? Doug |
From: Aaron H. <aa...@me...> - 2002-05-20 14:57:28
|
We have been testing out happyDoc to use against the source for Webware.sourceforge.net and its great so far. Currently the project comes with a simple source based documentation that just writes our the pages as html. Is there a way to map the classes and methods in the HappyDoc output to the actual source pages. (In the highly unlikely event that some methods are not documented?) HappyDocs at webware.metrony.com for now. Thank You, -Aaron Held =================================================================== As Isaac Newton would say now: If I see further than others, it is because I stand on the shoulders of giants too dumb to patent their discoveries. (Gregory Palast, http://www.observer.co.uk/ ) |