Skip to content

[Bug] sphinx_autodoc_typehints Cannot resolve forward reference #79

Closed

Description

@stevepiercy

Describe the bug

When building the docs, a warning appears.

/home/docs/checkouts/calendaring-jmap/checkouts/78/.venv/lib/python3.13/site-packages/niquests/async_session.py:140: WARNING: Cannot resolve forward reference in type annotations of "calendaring_jmap.async_client.AsyncSession" (module niquests.async_session): name 'AsyncLifeCycleHook' is not defined [sphinx_autodoc_typehints.forward_reference] 

To reproduce

make html

For now, I removed the -W flag from the ALLSPHINXOPTS in Makefile.

I don't know how to resolve this issue, other than remove the Sphinx extension, but that merely avoids the issue.

See:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions