notmuch/doc, branch debian/0.29.2-2

doc: Don't install emacs docs when they are not built

2019-06-11T00:48:03Z

In 40b025 we stopped building the notmuch-emacs documentation if HAVE_EMACS=0 (i.e. no emacs was detected by configure). Unfortunately we continued to try to install the (non-existent) documentation, which causes build/install failures. As a bonus, we also avoid installing the documentation if the user configures --without-emacs. Thanks to Ralph Seichter for reporting the problem, and testing previous versions of this fix.

doc: don't build notmuch-emacs.info for configure --without-emacs

2019-06-11T00:46:55Z

Since the docstrings are not built in the case of --without-emacs, even if emacs is detected, don't let sphinx build the emacs docs. This avoids a large number of error messages due to missing includes. It's actually a bit surprising sphinx doesn't generate an error for the missing include files.

doc: use separate doctrees for distinct builders

2019-06-03T10:35:30Z

It seems our previous attempt with order-only targets was not sufficient to avoid problems with sphinx-builds doctree cache [0]. Looking around at other people's approaches [1], using separate doctrees was suggested. I guess there might be a slight loss of efficiency, but it seems more robust. [0]: build failures were first noticed in Debian experimental, but I was able to duplicate it in my usual build environment about 1 in 8 builds. [1]: in particular https://salsa.debian.org/mpd-team/mpc/commit/9e3fc1657d043d75755993846c93f7700b97f907

doc: document user header indexing.

2019-05-25T10:21:21Z

It's a bit odd that the primary documentation is in notmuch-config, but it is consistent with the "query:" prefix.

doc: exclude notmuch-emacs.rst if emacs is not present.

2019-04-24T09:53:13Z

This will still generate a warning about an excluded document in the toctree, but it cuts down on the noise quite a lot.

doc: use stamp file for html docs

2019-04-24T09:53:13Z

These are less time consuming than the texi docs to rebuild (because the texi rebuild triggers info rebuild), but still take noticable time.

doc: use stamp file to control rebuilding texi

2019-04-24T09:53:07Z

Apparently the sphinx-doc texinfo builder is not smart enough to only rebuild those files where the source has changed.

lib: add 'body:' field, stop indexing headers twice.

2019-04-17T11:48:16Z

The new `body:` field (in Xapian terms) or prefix (in slightly sloppier notmuch) terms allows matching terms that occur only in the body. Unprefixed query terms should continue to match anywhere (header or body) in the message. This follows a suggestion of Olly Betts to use the facility (since Xapian 1.0.4) to add the same field with multiple prefixes. The double indexing of previous versions is thus replaced with a query time expension of unprefixed query terms to the various prefixed equivalent. Reindexing will be needed for 'body:' searches to work correctly; otherwise they will also match messages where the term occur in headers (demonstrated by the new tests in T530-upgrade.sh)

doc: document notmuch new --verbose

2019-03-31T14:59:46Z

doc: Clean up warnings when building notmuch-emacs docs

2019-03-27T20:45:27Z

Without this change, we see this during the build: sphinx-build -b html -d doc/_build/doctrees -q ./doc doc/_build/html …/doc/notmuch-emacs.rst:67: WARNING: Unexpected indentation. …/doc/notmuch-emacs.rst:165: WARNING: Unexpected indentation. …/doc/notmuch-emacs.rst:306: WARNING: Unexpected indentation. This source change doesn't seem to have any effect on the generated HTML, at least. Signed-off-by: Daniel Kahn Gillmor