You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
Cython modules that use __init__.pyx/__init__.so instead of __init__.py are broken with sphinxcontrib.apidoc. They appear to be not picked up correctly by whatever internal component that uses (apidoc or autodoc I assume) and it gives a strange listing of the parent folder of the module only
To Reproduce
Steps to reproduce the behavior:
$ git clone https://github.com/wobblui/wobblui ./testblah
$ cd testblah/docs
$ make html
$ # open ./build/html/reference/modules.html and see it lists the "src" folder instead of the "wobblui" module
Expected behavior docs/build/html/reference/modules.html will list "wobblui" module after docs build (that DOES happen by the way if you touch src/wobblui/__init__.py, but of course that breaks the module and the functions in src/wobblui/__init__.pyx may not be documented properly)
Sphinx extensions: sphinxcontrib.apidoc should be the relevant one
Extra tools: none that I'm aware of(?)
Additional context
I already filed a ticket here: sphinx-contrib/apidoc#13 and it was suggested that the problem is probably in sphinx itself or apidoc/autodoc
The text was updated successfully, but these errors were encountered:
Is anyone aware of a workaround? Other than just adding an __init__.py file which doesn't fully do the job since then the __init__.pyx won't get documented (but at least the other modules will I suppose). I would also be interested in trying out any dev version of sphinx with an experimental change to improve this
Unfortunately, current implementation of apidoc only refers __init__.py. So we need to modify apidoc to do that. But I'm not familiar with apidoc. So it is a bit tough work to me...
Describe the bug
Cython modules that use
__init__.pyx
/__init__.so
instead of__init__.py
are broken withsphinxcontrib.apidoc
. They appear to be not picked up correctly by whatever internal component that uses (apidoc or autodoc I assume) and it gives a strange listing of the parent folder of the module onlyTo Reproduce
Steps to reproduce the behavior:
Expected behavior
docs/build/html/reference/modules.html
will list "wobblui" module after docs build (that DOES happen by the way if youtouch src/wobblui/__init__.py
, but of course that breaks the module and the functions insrc/wobblui/__init__.pyx
may not be documented properly)Your project
https://github.com/wobblui/wobblui (docs are inside "docs" folder, try "make html" as in steps above)
Screenshots
Environment info
sphinx-quickstart --version
says 1.7.6Additional context
I already filed a ticket here: sphinx-contrib/apidoc#13 and it was suggested that the problem is probably in sphinx itself or apidoc/autodoc
The text was updated successfully, but these errors were encountered: