Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.3.2 causing reference target not found errors for named tuples #485

Closed
selimt opened this issue Sep 30, 2024 · 1 comment
Closed

3.3.2 causing reference target not found errors for named tuples #485

selimt opened this issue Sep 30, 2024 · 1 comment
Labels

Comments

@selimt
Copy link

selimt commented Sep 30, 2024

We recently started getting CI failures and the cause was the 3.3.2 release of autoapi.

Although a class was imported and declared in the rst file, we started getting the following error:

sphinx.errors.SphinxWarning: /app/docstring of catalog.CatalogClient.get_taggables_unique_values:1:py:class reference target not found: catalog.schemas.UniqueValue

UniqueValue is a named tuple is declared as:

UniqueValue = collections.namedtuple(
    "UniqueValue", ("value", "count")
)

And is included in the documentation as:

.. autoapimodule:: catalog.schemas
    :members:  [redacted], UniqueValue

Going back to release 3.3.1 resolves the issue.

Thanks in advance.

@AWhetter AWhetter added the Bug label Oct 12, 2024
@AWhetter
Copy link
Collaborator

Are you sure that this is caused by a change in AutoAPI? AutoAPI is documenting UniqueValue as an attribute, whereas the error message makes it look like you're trying to reference it with :class:.

Either way, I'm going to get AutoAPI to report namedtuples that are created with the functional syntax as classes. Same as it would if you had created a class that inherits from namedtuple.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants