Sphinx documentation of class methods is incomplete
Bug #1031215 reported by
Jan Stránský
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Yade |
Confirmed
|
Undecided
|
Unassigned |
Bug Description
see e.g. export.VTKExporter, https:/
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 post a comment you must log in.
The same problem appears apparently for all nested doc (i.e. documented function in a python class) /yade-dem. org/doc/ yade.post2d. html?highlight= helixflatten# yade.post2d. HelixFlatten
Like here:
https:/
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.