Sphinx documentation of class methods is incomplete

Bug #1031215 reported by Jan Stránský
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Yade
Confirmed
Undecided
Unassigned

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)

Revision history for this message
Bruno Chareyre (bruno-chareyre) wrote :

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
Revision history for this message
Janek Kozicki (cosurgi) wrote :
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers