Comments on: A quick tryout: Documentation Generating for Plone products http://blog.mfabrik.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/ Freedom delivered. Mon, 19 Sep 2011 19:02:42 +0000 hourly 1 http://wordpress.org/?v=3.2.1 By: Tuukka Mustonen http://blog.mfabrik.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/comment-page-1/#comment-129 Tuukka Mustonen Sat, 08 Sep 2007 12:39:06 +0000 http://blog.redinnovation.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/#comment-129 Nice to see replies to my very first post :) DocFinder(Tab) is useful extension but provides overview to only objects themselves and for only one at a time. It doesn't explain how code functions and how things relate to each other. I haven't actually used ArchGenXML yet, but I took a look at the stereotype and tagged value references that Reinout van Rees mentioned. The lists are something I would like to see for every plone product, not to mention the plone bundle itself. Oh yes, Plone actualy _has_ API, but for comparison, take a look at ruby API at http://api.rubyonrails.org/ and http://api.plone.org Which one do you think actually helps a developer? PyDoctor seems nice, but it lacks visualization, relation maps etc (it only produces listings of modules, methods, classes etc.). Support for Zope interfaces sure is a step forward, however. Still, we are far away from where we could be (reverse-UML that might be). Nice to see replies to my very first post :)

DocFinder(Tab) is useful extension but provides overview to only objects themselves and for only one at a time. It doesn’t explain how code functions and how things relate to each other.

I haven’t actually used ArchGenXML yet, but I took a look at the stereotype and tagged value references that Reinout van Rees mentioned. The lists are something I would like to see for every plone product, not to mention the plone bundle itself. Oh yes, Plone actualy _has_ API, but for comparison, take a look at ruby API at http://api.rubyonrails.org/ and http://api.plone.org Which one do you think actually helps a developer?

PyDoctor seems nice, but it lacks visualization, relation maps etc (it only produces listings of modules, methods, classes etc.). Support for Zope interfaces sure is a step forward, however. Still, we are far away from where we could be (reverse-UML that might be).

]]> By: Raphael Ritz http://blog.mfabrik.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/comment-page-1/#comment-115 Raphael Ritz Wed, 05 Sep 2007 07:31:47 +0000 http://blog.redinnovation.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/#comment-115 You might want to take a look at pydoctor as well http://codespeak.net/~mwh/pydoctor https://launchpad.net/pydoctor It has at least some support for Zope's interfaces. Raphael You might want to take a look at pydoctor as well

http://codespeak.net/~mwh/pydoctor

https://launchpad.net/pydoctor

It has at least some support for Zope’s interfaces.

Raphael

]]> By: Reinout van Rees http://blog.mfabrik.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/comment-page-1/#comment-113 Reinout van Rees Tue, 04 Sep 2007 18:12:43 +0000 http://blog.redinnovation.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/#comment-113 Another approach: generate end-user documentation from the code. Example: the tagged value and stereotype lists of archgenxml on plone.org. I modified the archgenxml code so that it itself could generate those lists: code and documentation are in sync. Also in instancemanager, some end-user documentation is generated. Both are not the types of generated documentation you talk about in your article, but worthy of a mention, too :-) Reinout Another approach: generate end-user documentation from the code. Example: the tagged value and stereotype lists of archgenxml on plone.org. I modified the archgenxml code so that it itself could generate those lists: code and documentation are in sync.

Also in instancemanager, some end-user documentation is generated.

Both are not the types of generated documentation you talk about in your article, but worthy of a mention, too :-)

Reinout

]]> By: Tiberiu Ichim http://blog.mfabrik.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/comment-page-1/#comment-112 Tiberiu Ichim Tue, 04 Sep 2007 18:07:37 +0000 http://blog.redinnovation.com/2007/09/03/a-quick-tryout-documentation-generating-for-plone-products/#comment-112 It's not clear to my from your blog post if you're aware of DocFinder and DocFinderTab, which generate at runtime the docstrings, through introspection of live objects. It’s not clear to my from your blog post if you’re aware of DocFinder and DocFinderTab, which generate at runtime the docstrings, through introspection of live objects.

]]>