need help tracking down a cross reference error

616 views
Skip to first unread message

Vince West

unread,
Dec 28, 2017, 7:28:59 PM12/28/17
to sphinx-users
I am pretty new to sphinx, but I am trying to set up documentation for a project I am working on.

I am using the napoleon extension with numpy docstrings and I am getting many errors that look like this;

C:\Coding\Python\PythonPackageLinks\dataquick\loaders.py:docstring of dataquick.loaders.load_dqftxt:: WARNING: more than one target found for cross-reference 'DataQuickFrame': dataquick.structures.dataquickframe.DataQuickFrame, dataquick.structures.DataQuickFrame
C:\Coding\Python\PythonPackageLinks\dataquick\loaders.py:docstring of dataquick.loaders.load_file:: WARNING: more than one target found for cross-reference 'DataQuickFrame': dataquick.structures.dataquickframe.DataQuickFrame, dataquick.structures.DataQuickFrame

I tried to construct a simple setup as per this question on StackOverflow

However, I was not able to reproduce the problem this way.  As such, I am not sure what is causing the Warning and I am looking for guidance as to how I might figure it out

Thank you
Vince

Komiya Takeshi

unread,
Dec 28, 2017, 8:09:24 PM12/28/17
to sphinx...@googlegroups.com
Hi,

The message says many `DataQuickFrame` class are found at

* dataquick.structures.dataquickframe.DataQuickFrame
* dataquick.structures.DataQuickFrame

So referencing `DataQuickFrame` is ambiguity.

I guess it will be resolved with adding namespace to references like
:class:`dataquick.structures.DataQuickFrame`.

Thanks,
Takeshi KOMIYA
> --
> 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 sphinx-users...@googlegroups.com.
> To post to this group, send email to sphinx...@googlegroups.com.
> Visit this group at https://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/d/optout.

Vince West

unread,
Dec 29, 2017, 4:23:09 PM12/29/17
to sphinx-users
Thanks.  I am not completely certain of my problem, but I think it is related to having classes defined in one module and then including those classes in the __all__ list of a different module for namespace reasons.  Only using autodoc in one of the modules seems to have fixed the problem.
Reply all
Reply to author
Forward
0 new messages