Hi there During Fedora package builds I noticed that autodoc fails to import the notmuch2 module:
``` WARNING: autodoc: failed to import module 'notmuch2'; the following exception was raised: No module named 'notmuch2' ``` You never notice this on your own box where notmuch2 is installed, because then the build finds the previously installed module. But this is wrong, of course, because autodoc is supposed to document tthe module being build (in-source module). There are actually several problems leading to this: 1. search path The module residing in `bindings/python-cffi/notmuch2/__init__.py` needs a search path `bindings/python-cffi/`, not `bindings/python-cffi/notmuch2`. If we fix just that we get: ``` WARNING: autodoc: failed to import module 'notmuch2'; the following exception was raised: cannot import name '_capi' from partially initialized module 'notmuch2' (most likely due to a circular import) (/builddir/build/BUILD/notmuch-0.34/doc/../bindings/python-cffi/notmuch2/__init__.py) ``` 2. search path, again The module is built in `bindings/python-cffi/build/stage`, that is where `_capi` is to be found, and PATCH 1/1 fixes the path in `doc/conf.py`. 3. build order The patch from 2. actually helps only if we build in the following order (make targets): notmuch notmuch-shared ruby-bindings python-cffi-bindings all In particular, the bindings need to be built before the docs I can do this using two make calls, but a proper solution would specify the dependencies in the makefile. 4. library search path When you do 1. through 3. then autodoc almost manages to import notmuch2: it finds the proper module, _capi is found, but then libnotmuch.so is not found because LD_LIBRARY_PATH would need to be amended to find the freshly build library. Now, maybe I should simply ignore the autodoc warning. Or I should change my packaging to build twice (make && make install && make clean && make && make install). At least I wanted to raise attention to this. This problem (if it is one) is not specific to 0.34, it was the same at least with 0.33 but - being just a warning - was unnoticed. Cheers Michael Michael J Gruber (1): autodoc: fix search path for notmuch2 module doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- 2.33.0.1146.g7ac282475c _______________________________________________ notmuch mailing list -- notmuch@notmuchmail.org To unsubscribe send an email to notmuch-le...@notmuchmail.org
