Skip to content
New issue

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

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

Already on GitHub? # to your account

sphinx.errors.ExtensionError: Handler <function build_finished> for event 'build-finished' threw an exception #224

Closed
IlyaFaer opened this issue Jul 13, 2022 · 1 comment
Labels
type: question Request for information or clarification. Not an issue.

Comments

@IlyaFaer
Copy link

Hi!

We've got a failure of the docfx while building docs, like this:

Traceback (most recent call last):
  File "/home/runner/work/python-spanner-django/python-spanner-django/.nox/docfx/lib/python3.8/site-packages/sphinx/events.py", line 94, in emit
    results.append(listener.handler(self.app, *args))
  File "/home/runner/work/python-spanner-django/python-spanner-django/.nox/docfx/lib/python3.8/site-packages/docfx_yaml/extension.py", line 1830, in build_finished
    obj['references'].append(_create_reference(attrData, parent))
  File "/home/runner/work/python-spanner-django/python-spanner-django/.nox/docfx/lib/python3.8/site-packages/docfx_yaml/extension.py", line 239, in _create_reference
    'name': datam['source']['id'],
KeyError: 'source'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/runner/work/python-spanner-django/python-spanner-django/.nox/docfx/lib/python3.8/site-packages/sphinx/application.py", line 331, in build
    self.events.emit('build-finished', None)
  File "/home/runner/work/python-spanner-django/python-spanner-django/.nox/docfx/lib/python3.8/site-packages/sphinx/events.py", line 102, in emit
    raise ExtensionError(__("Handler %r for event %r threw an exception") %
sphinx.errors.ExtensionError: Handler <function build_finished at 0x7f1fb3f89ee0> for event 'build-finished' threw an exception (exception: 'source')

Here is the full log:
https://github.com/googleapis/python-spanner-django/runs/7320162836?check_suite_focus=true

Error message is not very helpful. As far as I understand, there is a wrong reference somewhere, but without any information about it in the traceback it's pretty challenging to figure which of the references is incorrect. Should be improved, I think.

@IlyaFaer IlyaFaer added the type: question Request for information or clarification. Not an issue. label Jul 13, 2022
@IlyaFaer IlyaFaer changed the title sphinx.errors.ExtensionError: Handler <function build_finished at xxx> for event 'build-finished' threw an exception (exception: 'source') sphinx.errors.ExtensionError: Handler <function build_finished> for event 'build-finished' threw an exception Jul 13, 2022
@dandhlee
Copy link
Collaborator

Hey there, I've already opened an issue to look into it in googleapis/python-spanner-django#768. The issue should be specific to the spanner django repo so I'll close this issue here.

@dandhlee dandhlee closed this as not planned Won't fix, can't repro, duplicate, stale Jul 14, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
type: question Request for information or clarification. Not an issue.
Projects
None yet
Development

No branches or pull requests

2 participants