yade-dev team mailing list archive

Thread
Date

[Bug 401002] Re: Make epydoc (python) reference more useful

To: yade-dev@xxxxxxxxxxxxxxxxxxx
From: Václav Šmilauer <eudoxos@xxxxxxxx>
Date: Sun, 25 Apr 2010 16:06:05 -0000
Reply-to: Bug 401002 <401002@xxxxxxxxxxxxxxxxxx>
Sender: bounces@xxxxxxxxxxxxx

This is fixed by sphinx documentation at https://www.yade-
dem.org/sphinx/yade.wrapper.html. Fixing documentation of individual
classes is a different issue.

** Changed in: yade
   Importance: Undecided => Medium

** Changed in: yade
       Status: New => Fix Released

** Changed in: yade
    Milestone: None => 0.5

-- 
Make epydoc (python) reference more useful
https://bugs.launchpad.net/bugs/401002
You received this bug notification because you are a member of Yade
developers, which is subscribed to Yade.

Status in Yet Another Dynamic Engine: Fix Released

Bug description:
Since r1876, epydoc documentation can be generated by 
 
 cd doc; yade-something yade-epydoc.py

and found in epydoc/index.html directory afterwards. There are many classes that are documented or badly documented. Further, separating module-private and exported things should be done to not have too much confusing documentation.