Fix warnings when generating the python programmer's reference

Registered by Kristian B. ├ślgaard

We currently get 648 warnings when building the Python part of the programmer's reference.
The warnings have the form:

/home/oelgaard/software/fenics/fenics-doc/source/programmers-reference/python/cpp/uBLASVector.rst:10: (WARNING/2) error while formatting arguments for dolfin.cpp.uBLASVector.copy: arg is not a Python function

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

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.uBlasSparseFactory(...), resulting in these warnings. These warnings are significant though, because the generated signatures are incomplete and the formatting is off.

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.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.