Hi,

I am documenting a small project named pandaSDMX (about 10 modules,
about 1500 lines) using Sphinx 1.3.1, sphinx-apidoc, napoleon and
codeview.

The module pandasdmx.api contains two classes: `Request`and `Response`:

https://github.com/dr-leo/pandaSDMX/blob/v0.2dev/pandasdmx/api.py

But the auto-generated api documentation only documents the `Request`class:

http://pandasdmx.readthedocs.org/en/latest/api/pandasdmx.html.

References to `pandasdmx.api.Response`, e.g. in the module docstring
of `pandasdmx.api`, are rendered as normal text. No error or warning
is raised.

pandasdmx.api imports importlib and a method  in
pandasdmx.api.Response` calls `importlib.mport_module`. Otherwise, the
import machinery is untouched. Hence, the warning in the documentation
of autodoc should not be pertinent.

In case this is of interest: pandasdmx.__init__.py contains the line

from pandasdmx.api import Request

And `pandasdmx.api.Request` has a property and inherits explicitly
from `object`, while `pandasdmx.api.Response` does not.

This issue seems hard to debug. E.g., when disabling napoleon, the
docstrings cause errors as they do not contain rST.

My best guess is that there is a bug in automodule.

Any idea?

Leo

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to