yade-users team mailing list archive

[Václav Šmilauer <eudoxos@xxxxxxxx>]

> Just a problem of path indeed... For information I managed to generate 
> the epydoc finally.
Oh, did you? (it didn't work for me when I tried this morning, after
reading your message).

I updated FAQ at https://yade-dem.org/wiki/FAQ#Python_Documentation.

The advantage of sphinx is (besides it looks better and lets you put in
hand-written stuff as well) is that it can _run_ parts of code while
generating the documentation. So all the "Yade [51]:" etc promps you see
are actually run when documentation is being compiled, having always
up-to-date results (including the less pleasant ones, like
https://www.yade-dem.org/sphinx/basics.html#creating-simulation, saying

  TriaxialTest is not defined

(Bruno, ping...? ;-) )

Cheers, v.