← Back to team overview

zim-wiki team mailing list archive

Re: Epydoc error

 

Hi John,

Yes I've seen these errors as well. Afraid Epydoc is not as stable as I
hoped when I started using it. It tends to break on some docstrings without
clearly telling where the problem is.

THe other way of accessing the documentation is of course "pydoc", pydoc
can also generate HTML, by it not so pretty as the epydoc output.

Regards,

Jaap



On Mon, May 27, 2013 at 2:23 PM, <janpacovsky@xxxxxxxxxx> wrote:

> Hi,
>
>
>
> I can't make epydoc work,
>
>
>
> I have tried win xp,7,8; linux mint and ubuntu, both versions of epydoc
> 2.1 and 3.0.1
>
> on sources 0.54 and 0.60
>
> and I got pretty much the same result
>
> the epydoc 2.1 didn't work at all.The 3.0.1 version stops at 68%
>
> with an error: AttributeError: _Sentinel instance has no attribute
> 'docstring'
>
>
>
> I run it with the "--config epydoc.conf" parameter.
>
>
>
> This is output in debug + verbose mode:
>
>
>
> Exception in template write_function_details_entry() on line
> 112:            out('    </dt>\n')
> Traceback (most recent call last):
>   File "C:\Python27\Scripts\epydoc.py", line 16, in <module>    cli()
>   File "C:\Python27\lib\site-packages\epydoc\cli.py", line 965, in cli
> main(options, names)
>   File "C:\Python27\lib\site-packages\epydoc\cli.py", line 783, in main
> write_html(docindex, options)
>   File "C:\Python27\lib\site-packages\epydoc\cli.py", line 823, in
> write_html    html_writer.write(options.target)
>   File "C:\Python27\lib\site-packages\epydoc\docwriter\html.py", line 641,
> in write    self._write(self.write_class, directory, filename, doc)
>   File "C:\Python27\lib\site-packages\epydoc\docwriter\html.py", line 711,
> in _write    write_func(f.write, *args)
>   File "C:\Python27\lib\site-packages\epydoc\docwriter\html.py", line 913,
> in write_class    "instancevariable")
>   File "C:\Python27\lib\site-packages\epydoc\docwriter\html.py", line
> 2214, in write_details_list    self.write_details_entry(out, var_doc)
>   File "C:\Python27\lib\site-packages\epydoc\docwriter\html.py", line
> 2247, in write_details_entry    div_class)
>   File "<string>", line 112, in write_function_details_entry
> AttributeError: _Sentinel instance has no attribute 'docstring'
>
>
>
> So what should I do to make it work?
>
>
>
> Or is there another way how to see the program output without runing the
> script on my mashine?
>
>
>
>
>
> Thanks ahead.
>
> John
>
> AfrikaansAlbanianArabicArmenianAzerbaijaniBasqueBelarusianBulgarianCatalanChinese
> (Simplified)Chinese (Traditional)CroatianCzechDanishDetect languageDutch
> EnglishEstonianFilipinoFinnishFrenchGalicianGeorgianGermanGreekHaitian
> CreoleHebrewHindiHungarianIcelandicIndonesianIrishItalianJapaneseKorean
> LatinLatvianLithuanianMacedonianMalayMalteseNorw egianPersianPolish
> PortugueseRomanianRussianSerbianSlovakSlovenianSpanishSwahiliSwedishThai
> TurkishUkrainianUrduVietnameseWelshYiddish⇄AfrikaansAlbanianArabicArmenian
> AzerbaijaniBasqueBelarusianBulgarianCatalanChinese (Simplified)Chinese
> (Traditional)CroatianCzechDanishDutchEnglishEstonianFilipinoFinnishFrench
> GalicianGeorgianGermanGreekHaitian CreoleHebrewHindiHungarianIcelandic
> IndonesianIrishItalianJapaneseKoreanLatinLatvianLithuanianMacedonianMalay
> MalteseNorwegianPersianPolishPortugueseRomanianRussianSerbianSlovak
> SlovenianSpanishSwahiliSwedishThaiTurkishUkrainianUrduVietnameseWelsh
> Yiddish
> Detect language » Czech
>
> _______________________________________________
> Mailing list: https://launchpad.net/~zim-wiki
> Post to     : zim-wiki@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~zim-wiki
> More help   : https://help.launchpad.net/ListHelp
>
>

References