Problems creating api documentation from kiwi 1.9.18 source

Goedson Teixeira Paixao goedson at debian.org
Thu Sep 20 17:52:25 BRT 2007 

Hi,

First of all, thank you for the gret work put into kiwi's development.

I'm trying to create a Debian's kiwi package for version 1.9.18 and I'm
having trouble trying to generate API docs from it's source code.

Using Debian's current pydoctor version (0.2) I've got this output:

------------- begining of version 0.2 output ---------------------------

Creating API documentation
adding directory kiwi
findImportStars
63 / 63 modules parsed 
extractDocstrings
63 / 63 modules parsed 2 warnings 
finalStateComputations
writing html to apidocs using pydoctor.html.SystemWriter
Traceback (most recent call last):
  File "/usr/bin/pydoctor", line 5, in ?
    main(sys.argv[1:])
  File "/var/lib/python-support/python2.4/pydoctor/driver.py", line 287,
in main
    writer.writeIndividualFiles(subjects, options.htmlfunctionpages)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 185,
in writeIndividualFiles
    self.writeIndividualFiles(sub.orderedcontents, functionpages)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 185,
in writeIndividualFiles
    self.writeIndividualFiles(sub.orderedcontents, functionpages)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 181,
in writeIndividualFiles
    html = self.getHTMLFor(sub)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 194,
in getHTMLFor
    d = fun(o)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 272,
in html_Class
    x += self._genChildren(cls.orderedcontents, link=link)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 363,
in _genChildren
    x += ('<tr class="%(kindLower)s"><td>%(kind)s</td>'
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 30, in
summaryDoc
    return doc2html(obj, doc)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 53, in
g
    r = _cache[args] = f(*args)
  File "/var/lib/python-support/python2.4/pydoctor/html.py", line 84, in
doc2html
    crap = pdoc.to_html(_EpydocLinker(obj))
AttributeError: 'NoneType' object has no attribute 'to_html'
make: ** [api] Erro 1

------------- end of version 0.2 output -------------------------------

Then I thought this version could be out of date in regards with the
features used in kiwi's documentation so I've got a fresh checkout from
pydoctor's subversion repository (revision #46772). It in fact got some
further than version 0.2 but failed with the following output:

------------- begining of svn 46772 output --------------------------
Creating API documentation
adding directory /home/goedson/Desktop/Downloads/kiwi-1.9.18/kiwi
74 modules and packages discovered 
analyseImports
68/68 modules parsed 
extractDocstrings
6/68 modules parsed 0 warnings moving Function
'kiwi.currency.format_price' into Module 'kiwi.datatypes'
68/68 modules parsed 2 warnings 
finalStateComputations
writing html to apidocs using pydoctor.nevowhtml.writer.NevowWriter
starting ModuleIndexPage ... took 0.057272s
starting ClassIndexPage ... took 0.210672s
starting IndexPage ... took 0.006451s
starting NameIndexPage ... took 0.404660s
starting UndocumentedSummaryPage ... took 0.141053s
152/296 pages written 
found unknown field on 'kiwi.ui.objectlist.Column.__init__': <Field
'keyword' 'title_pixmap' '(TODO) if set to a ...n'>
153/296 pages written
found unknown field on 'kiwi.ui.objectlist.SequentialColumn.__init__':
<Field 'keyword' 'title_pixmap' '(TODO) if set to a ...n'>
154/296 pages written
found unknown field on 'kiwi.ui.objectlist.ColoredColumn.__init__':
<Field 'keyword' 'title_pixmap' '(TODO) if set to a ...n'>
243/296 pages written 
found unknown field on 'kiwi.dist.setup': <Field 'kwarg' 'resources' ''>
found unknown field on 'kiwi.dist.setup': <Field 'kwarg'
'global_resources' ''>
found unknown field on 'kiwi.dist.setup': <Field 'kwarg' 'templates'
'List of templates t...n'>
279/296 pages written 
found unknown field on 'kiwi.tasklet.get_event': <Field 'warning' None
'this function shoul...n'>
found unknown field on 'kiwi.tasklet.run': <Field 'parameter' 'gen'
'generator object th...n'>
281/296 pages written 
found unknown field on 'kiwi.tasklet.WaitCondition.arm': <Field
'parameter' 'tasklet' 'the tasklet instanc...n'>
found unknown field on 'kiwi.tasklet.WaitCondition.arm': <Field
'attention' None 'this method normall...n'>
found unknown field on 'kiwi.tasklet.WaitCondition.disarm': <Field
'attention' None 'this method normall...n'>
288/296 pages written 
found unknown field on 'kiwi.tasklet.WaitForProcess.__init__': <Field
'parameter' 'pid' 'Process identifier\n'>
290/296 pages written 
found unknown field on 'kiwi.tasklet.WaitForMessages.__init__': <Field
'warning' None 'unlike other wait c...n'>
291/296 pages written
found unknown field on 'kiwi.tasklet.Tasklet.run': <Field 'warning' None
'do NOT call this me...n'>
found unknown field on 'kiwi.tasklet.Tasklet.send_message': <Field
'warning' None 'Don\'t call this fr...n'>
292/296 pages written
found unknown field on 'kiwi.utils.gsignal': <Field 'keyword' 'flags' 'A
combination of;\n...n'>
found unknown field on 'kiwi.utils.gsignal': <Field 'keyword' 'retval'
'return value in sig...n'>
found unknown field on 'kiwi.utils.gproperty': <Field 'keyword'
'minimum' 'minimum allowed value\n'>
found unknown field on 'kiwi.utils.gproperty': <Field 'keyword'
'maximum' 'maximum allowed value\n'>
296/296 pages written 
these 100 objects' docstrings are not proper epytext:
    kiwi.ui.search.SearchSlaveDelegate
    kiwi.db.query.DateIntervalQueryState
    kiwi.db.query.DateQueryState
    kiwi.db.query.NumberQueryState
    kiwi.db.query.StringQueryState
    kiwi.ui.test.runner.Runner
    kiwi.db.query.QueryState.__init__
    kiwi.db.query.QueryExecuter.search
    kiwi.db.query.QueryExecuter.set_limit
    kiwi.db.sqlobj.SQLObjectQueryExecuter.search
    kiwi.ui.test.common.WidgetIntrospecter.parse_one
    kiwi.ui.test.recorder.Event.__init__
    kiwi.ui.test.recorder.SignalEvent.__init__
    kiwi.ui.test.recorder.Recorder.__init__
    kiwi.ui.test.runner.play_file
    kiwi.ui.test.runner.Runner.sleep
    kiwi.ui.test.runner.Runner.waitopen
    kiwi.ui.test.runner.Runner.waitclose
    kiwi.ui.proxywidget.ProxyWidgetMixin.update
    kiwi.ui.proxywidget.ValidatableProxyWidgetMixin.is_valid
    kiwi.ui.comboentry.ComboEntry.__init__
    kiwi.ui.comboentry.ComboEntry.set_text
    kiwi.ui.comboentry.ComboEntry.get_text
    kiwi.ui.comboentry.ComboEntry.get_model
    kiwi.ui.comboentry.ComboEntry.set_active_iter
    kiwi.ui.comboentry.ComboEntry.get_active_iter
    kiwi.ui.widgets.entry.ProxyEntry.set_mask_for_data_type
    kiwi.ui.entry.KiwiEntry.get_mask
    kiwi.ui.dateentry.DateEntry.set_date
    kiwi.ui.dateentry.DateEntry.get_date
    kiwi.ui.widgets.filechooser.ProxyFileChooserWidget.__init__
    kiwi.ui.widgets.filechooser.ProxyFileChooserButton.__init__
    kiwi.ui.widgets.label.ProxyLabel.__init__
    kiwi.ui.objectlist.ObjectList.__init__
    kiwi.ui.objectlist.ObjectList.set_columns
    kiwi.ui.objectlist.ObjectList.get_selected_row_number
    kiwi.ui.objectlist.ObjectList.set_headers_visible
    kiwi.ui.objectlist.ObjectList.get_dnd_targets
    kiwi.ui.views.SlaveView.get_sizegroups
    kiwi.ui.delegates.ProxyDelegate.set_model
    kiwi.ui.icon.IconEntry.set_pixbuf
    kiwi.ui.listdialog.ListContainer.__init__
    kiwi.ui.listdialog.ListContainer.set_list_type
    kiwi.ui.listdialog.ListDialog.set_list_type
    kiwi.ui.listdialog.ListDialog.add_list_item
    kiwi.ui.listdialog.ListDialog.add_list_items
    kiwi.ui.listdialog.ListDialog.remove_list_item
    kiwi.ui.listdialog.ListDialog.update_list_item
    kiwi.ui.objectlist.ObjectTree.append
    kiwi.ui.objectlist.ObjectTree.prepend
    kiwi.ui.objectlist.ListLabel.__init__
    kiwi.ui.proxy.Proxy.__init__
    kiwi.datatypes.BaseConverter.as_string
    kiwi.datatypes.BaseConverter.from_string
    kiwi.datatypes.BaseConverter.get_compare_function
    kiwi.datatypes.BaseConverter.get_mask
    kiwi.ui.search.DateSearchOption.get_interval
    kiwi.ui.search.DateSearchFilter.__init__
    kiwi.ui.search.DateSearchFilter.get_start_date
    kiwi.ui.search.DateSearchFilter.get_end_date
    kiwi.ui.search.ComboSearchFilter.__init__
    kiwi.ui.search.StringSearchFilter.__init__
    kiwi.ui.search.SearchContainer.__init__
    kiwi.ui.search.SearchContainer.set_filter_position
    kiwi.ui.search.SearchContainer.get_filter_position
    kiwi.ui.search.SearchContainer.set_text_field_columns
    kiwi.ui.selectablebox.SelectableBox.get_selected
    kiwi.ui.selectablebox.SelectableBox.set_selected
    kiwi.ui.selectablebox.SelectableBox._get_child_at_pos
    kiwi.ui.wizard.PluggableWizard.__init__
    kiwi.ui.wizard.PluggableWizard.set_message
    kiwi.currency.currency.__new__
    kiwi.decorators.deprecated.__init__
    kiwi.desktopparser.DesktopParser.set_locale
    kiwi.desktopparser.DesktopParser.get_locale
    kiwi.desktopparser.DesktopParser.get_string_list
    kiwi.desktopparser.DesktopParser.set_string_list
    kiwi.desktopparser.DesktopParser.get_integer_list
    kiwi.desktopparser.DesktopParser.set_integer_list
    kiwi.desktopparser.DesktopParser.get_boolean_list
    kiwi.desktopparser.DesktopParser.set_boolean_list
    kiwi.desktopparser.DesktopParser.set_string_list_locale
    kiwi.desktopparser.DesktopParser.get_string_list_locale
    kiwi.dist._VariableExtender.extend
    kiwi.interfaces.IEasyCombo.select
    kiwi.interfaces.IEasyCombo.select_item_by_label
    kiwi.interfaces.IEasyCombo.select_item_by_data
    kiwi.interfaces.IEasyCombo.get_selected_label
    kiwi.interfaces.IEasyCombo.get_selected_data
    kiwi.interfaces.IEasyCombo.get_selected
    kiwi.interfaces.ISearchFilter.get_state
    kiwi.log.set_log_file
    kiwi.log.set_log_level
    kiwi.python.qual
    kiwi.python.all
    kiwi.python.any
    kiwi.python.AttributeForwarder.__init__
    kiwi.python.enum.__new__
    kiwi.tasklet.WaitForIO.__init__
    kiwi.tasklet.Message.__init__
make: ** [api] Erro 2
------------- end of svn 46772 output -------------------------------

So, I'd like to know if you do have a private branch of pydoctor that's
able to generate kiwi's API documentation or which revision/command line
options do you use to generate or, finally, if I really won't be able to
generate API docs from current kiwi's sorce code.

Best regards,

-- 
Goedson Teixeira Paixao          http://mundolivre.wordpress.com/
Debian Project                   http://www.debian.org/
Jabber ID: goedson em jabber.org    http://www.jabber.org/

-------------- Próxima Parte ----------
Um anexo não texto foi limpo...
Nome  : não disponível
Tipo  : application/pgp-signature
Tam   : 189 bytes
Descr.: Esta =?ISO-8859-1?Q?=E9?= uma parte de mensagem
	assinada digitalmente
Url   : http://www.async.com.br/pipermail/kiwi/attachments/20070920/32d1628d/attachment.pgp

More information about the Kiwi mailing list