notmuch/doc/conf.py, branch 0.32.3

doc: fix man page build for Sphinx 4.x

2021-05-19T11:26:22Z

Sphinx 4.0 changed the default value of man_make_section_directory from False to True. We create the section directories and move the files manually, so fix the immediate man build failure by disabling the feature. The Sphinx documentation on this [1] is confusing, and has the change backwards. Git history says the default changed from False to True. [1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-man_make_section_directory

doc: bump copyright year

2021-02-18T11:55:28Z

Rename version to version.txt

2020-10-30T19:14:24Z

Building Notmuch on macOS is known to cause problems because the Notmuch distribution archive contains two files named "version". These names clash with the header as defined in C++20. Therefore, the existing naming will likely become a problem on other platforms as well, once compilers adopt the new standard. Signed-off-by: Ralph Seichter Amended-by: db s/keyword/header/ in commit message.

doc: add new python bindings to main documentation tree.

2020-07-15T11:37:11Z

A separate conf.py and doc directory (or will be needed if someone wants to build the bindings docs separately from notmuch.

doc: replace use of environment variables with a generated config

2020-07-15T11:32:15Z

It is getting unwieldy to pass configuration options on the sphinx-build command line, and I anticipate further use of conditionals. As far as I could tell, execing a string is the idiomatic way to emulate include in Python.

bump date in documentation

2020-06-01T23:58:52Z

doc: fix for out-of-tree builds of notmuch-emacs docs

2020-06-01T12:07:50Z

The sphinx-doc include directive does not have the ability to include files from the build tree, so we replace the include with reading the files in conf.py. The non-trivial downside of this is that the emacs docstrings are now defined for every rst source file. They are namespaced with docstring::, so hopefully there will not be any surprises. One thing that is noticable is a small (absolute) time penalty in running sphinx-doc.

build: drop variable HAVE_EMACS. use WITH_EMACS instead

2019-06-12T22:58:30Z

The extra flexibility of having both HAVE_EMACS (for yes, there is an emacs we can use) and WITH_EMACS (the user wants emacs support) lead to confusion and bugs. We now just force WITH_EMACS to 0 if no suitable emacs is detected.

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: 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.