When building out-of-tree, the documentation (both manpages and info
files) are incomplete, but they do not explicitly fail.  build logs
follow from doing "mkdir build && ../configure && make".

If there's a way to make these warnings into hard failures, i think that
would be good -- we don't want to accidentally ship the output they
create.  And of course actually fixing it would be even better.

I'm afraid i'm not proficient enough in sphinx to know how to do either,
so i'm just reporting a bug for now.

    --dkg

WITH_EMACS=1 sphinx-build -b man -d doc/_build/man_doctrees -q ../doc 
doc/_build/man
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:383: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:385: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch-lib.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:387: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch-show.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:389: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch-tag.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:220: WARNING: Undefined 
substitution referenced: "docstring::notmuch-message-headers".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:223: WARNING: Undefined 
substitution referenced: "docstring::notmuch-message-headers-visible".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:236: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-filename".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:239: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-git-send-email".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:242: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-message-id-stripped".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:245: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-mlarchive-link-and-go".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:248: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-tags".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:251: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-cc".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:254: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-date".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:257: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-from".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:260: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-message-id".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:263: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-mlarchive-link".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:266: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-subject".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:269: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-to".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:347: WARNING: Undefined 
substitution referenced: "docstring::notmuch-tagging-keys".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:353: WARNING: Undefined 
substitution referenced: "docstring::notmuch-cycle-notmuch-buffers".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:364: WARNING: Undefined 
substitution referenced: "docstring::notmuch-poll".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:367: WARNING: Undefined 
substitution referenced: "docstring::notmuch-poll-script".
[…]


WITH_EMACS=1 sphinx-build -b texinfo -d doc/_build/texinfo_doctrees -q ../doc 
doc/_build/texinfo
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:383: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:385: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch-lib.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:387: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch-show.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:389: WARNING: Problems with 
"include" directive path:
InputError: [Errno 2] No such file or directory: '../emacs/notmuch-tag.rsti'.
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:220: WARNING: Undefined 
substitution referenced: "docstring::notmuch-message-headers".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:223: WARNING: Undefined 
substitution referenced: "docstring::notmuch-message-headers-visible".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:236: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-filename".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:239: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-git-send-email".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:242: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-message-id-stripped".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:245: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-mlarchive-link-and-go".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:248: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-tags".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:251: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-cc".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:254: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-date".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:257: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-from".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:260: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-message-id".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:263: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-mlarchive-link".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:266: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-subject".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:269: WARNING: Undefined 
substitution referenced: "docstring::notmuch-show-stash-to".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:347: WARNING: Undefined 
substitution referenced: "docstring::notmuch-tagging-keys".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:353: WARNING: Undefined 
substitution referenced: "docstring::notmuch-cycle-notmuch-buffers".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:364: WARNING: Undefined 
substitution referenced: "docstring::notmuch-poll".
/home/dkg/src/notmuch/notmuch/doc/notmuch-emacs.rst:367: WARNING: Undefined 
substitution referenced: "docstring::notmuch-poll-script".

Attachment: signature.asc
Description: PGP signature

_______________________________________________
notmuch mailing list
notmuch@notmuchmail.org
https://notmuchmail.org/mailman/listinfo/notmuch

Reply via email to