Make epydoc (python) reference more useful

Bug #401002 reported by Václav Šmilauer
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Yade
Fix Released
Medium
Václav Šmilauer

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.

Changed in yade:
assignee: nobody → Václav Šmilauer (eudoxos)
Revision history for this message
Václav Šmilauer (eudoxos) wrote :
Revision history for this message
Anton Gladky (gladky-anton) wrote : Re: [Bug 401002] Re: Make epydoc (python) reference more useful

Information about Epydoc is added to FAQ

http://yade.wikia.com/wiki/FAQ
______________________________
[ENG] Best Regards
[GER] Mit freundlichen Grüßen
[RUS] С наилучшими пожеланиями
[UKR] З найкращими побажаннями

Anton Gladkyy

2009/7/18 Václav Šmilauer <email address hidden>

> Now availble online from http://beta.arcig.cz/~eudoxos/yade/epydoc/<http://beta.arcig.cz/%7Eeudoxos/yade/epydoc/>
>
> Added link to http://yade.wikia.com/wiki/Reference_documentation
>
> --
> Make epydoc (python) reference more useful
> https://bugs.launchpad.net/bugs/401002
> You received this bug notification because you are subscribed to Yade.
>
> Status in Yet Another Dynamic Engine: New
>
> 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.
>

Revision history for this message
Václav Šmilauer (eudoxos) wrote :

yade.wrapper.Omega should have docstrings (has none ATM)

Revision history for this message
Václav Šmilauer (eudoxos) wrote :

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
milestone: none → 0.5
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.