Documentation: Sphinx doesn't properly format many dolfin.cpp functions
Bug #799122 reported by
Marie Rognes
This bug affects 2 people
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
DOLFIN |
Confirmed
|
Medium
|
Unassigned |
Bug Description
Sphinx is having a hard time autodoc-ing many of the dolfin.cpp classes/functions. This shows up as O(10^3) warnings when running Sphinx for the Python documentation, _and_ as not properly formatted function arguments. See dolfin.
The reason for this is that Sphinx tries to extract the types of the arguments and the return arguments from the code, and does not understand how to relate to the _cpp module. (I think.)
Changed in dolfin: | |
milestone: | 1.0-rc1 → none |
To post a comment you must log in.