sphinx-autoapi icon indicating copy to clipboard operation
sphinx-autoapi copied to clipboard
verified publisher icon readthedocs

feat: add warning for missing imported object

Open arwedus opened this issue 1 year ago • 2 comments

Follow-up on https://github.com/readthedocs/sphinx-autoapi/pull/431

This warning is shown by sphinx build now when the "fullname" in the autoapi directive cannot be found in the imports, e.g. .. autoapiclass:: autoapi.mappers.python.objects.PythonPythonMapper give:

reading sources... [100%] reference/templates
WARNING: Failed to import class 'autoapi.mappers.python.objects.PythonPythonMapper' [autoapi.import]

Closes #419

arwedus avatar Nov 06 '24 18:11 arwedus

@AWhetter : Could you please review this PR? I don't understand why the test is failing for Py3.12, maybe you have an idea

arwedus avatar Nov 24 '24 10:11 arwedus

@arwedus Are you still looking to make this change? It looks like a valuable addition. I'm guessing that the failing test was that you need to add release notes (see https://github.com/readthedocs/sphinx-autoapi?tab=readme-ov-file#release-notes).

AWhetter avatar Jun 26 '25 04:06 AWhetter