Fix warnings when generating the python programmer's reference
We currently get 648 warnings when building the Python part of the programmer's reference.
The warnings have the form:
/home/oelgaard/
and is related to the dolfin.cpp module. I don't know where this is coming from.
Blueprint information
- Status:
- Started
- Approver:
- None
- Priority:
- Low
- Drafter:
- None
- Direction:
- Needs approval
- Assignee:
- None
- Definition:
- New
- Series goal:
- None
- Implementation:
-
Blocked
- Milestone target:
- None
- Started by
- Marie Rognes
- Completed by
Related branches
Related bugs
| Bug #799122: Documentation: Sphinx doesn't properly format many dolfin.cpp functions | Confirmed |
Sprints
Whiteboard
MER: Sphinx autodoc tries to automatically detect something about the input and return arguments for functions. It gets into problems when the return arguments are from _cpp, for instance _cpp.uBlasSpars
AL: What is the current status? Is this still a problem?
MER: Most definitely. Most of the warnings are due to a Sphinx fail. It might be possible to circumvent it by specially handling the formatting of signatures, but that might be significant pain. I'll ask the Sphinx people whether this is a known issue and whether it is likely to improve. This issue is also marked as a bug though, so this blueprint can probably be "closed".
Note that more errors in our own formatting seem to creep in however, probably since there are so many warnings that it is virtually impossible to see what is what.
