yade-dev team mailing list archive

[Bruno Chareyre <1031215@xxxxxxxxxxxxxxxxxx>]

The same problem appears apparently for all nested doc (i.e. documented function in a python class)
Like here:
https://yade-dem.org/doc/yade.post2d.html?highlight=helixflatten#yade.post2d.HelixFlatten

I don't see any mistake in the formatting of the docstring itself so I guess the solution is at a diferent level (conf.py, typically).
No clue how to fix presently.


** Changed in: yade
       Status: New => Confirmed

-- 
You received this bug notification because you are a member of Yade
developers, which is subscribed to Yade.
https://bugs.launchpad.net/bugs/1031215

Title:
  Sphinx documentation of class methods is incomplete

Status in Yet Another Dynamic Engine:
  Confirmed

Bug description:
  see e.g. export.VTKExporter, https://yade-dem.org/doc/yade.export.html#yade.export.VTKExporter .
  The documentation of exportSpheres and exportFacets function does not looks good and does not have documented parameters (although same docstring produced good documentation for functions in the same module)

To manage notifications about this bug go to:
https://bugs.launchpad.net/yade/+bug/1031215/+subscriptions