sphinx-autodoc2 icon indicating copy to clipboard operation
sphinx-autodoc2 copied to clipboard

Crash on Documenting Autogenerated Code

Open muellert opened this issue 1 year ago • 1 comments

I wanted to use autodoc2 to create documentation for the code in https://pypi.org/project/gitea/1.0.0/

But autodoc2 crashed with a stacktrace, see the attached log. My setup is as follows:

  • I untarred the tarball from PyPI and created a 'docs' subdirectory inside the top dir.
  • I ran sphinx-init and added '../../gitea' to 'autodoc2_packages' in 'sources/conf.y', as well as 'autodoc2' to the extensions.
  • I ran 'make html' in order to generate the documentation, which failed.

Then I manually ran 'autodoc2 list .' from the top directory ('gitea') to get the same stacktrace. autodoc2-failure.log

I am using Debian Bookworm with autodoc2 0.5.0 (ie, the latest).

The bug was introduces in PR #40.

muellert avatar Oct 12 '24 13:10 muellert