notmuch/doc/conf.py, branch 0.31_rc2thread-based email index, search, and tagginghttps://git.notmuchmail.org/git/notmuch/atom?h=0.31_rc22020-07-15T11:37:11Zdoc: add new python bindings to main documentation tree.2020-07-15T11:37:11ZDavid Bremnerdavid@tethera.net2020-07-11T13:20:27Zurn:sha1:a05da45523a8ce65a2db73040824bb7307e7351d
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 config2020-07-15T11:32:15ZDavid Bremnerdavid@tethera.net2020-07-11T13:20:26Zurn:sha1:0e03e2d45e36edb635229f356bf41f153c30a70f
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 documentation2020-06-01T23:58:52ZDavid Bremnerdavid@tethera.net2020-06-01T23:58:52Zurn:sha1:01fe987eec29b13f69309fa09730b6f8fc796c4adoc: fix for out-of-tree builds of notmuch-emacs docs2020-06-01T12:07:50ZDavid Bremnerdavid@tethera.net2020-05-31T16:15:03Zurn:sha1:ee8dba1c3013a00c0d1185583ea084f8ce3699b7
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 instead2019-06-12T22:58:30ZDavid Bremnerdavid@tethera.net2019-06-12T00:12:38Zurn:sha1:a6a8df7e0379bfb6e69b9541d7813ac71f624f2e
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-emacs2019-06-11T00:46:55ZDavid Bremnerdavid@tethera.net2019-06-11T00:06:57Zurn:sha1:71bf459596c72cf72b89c6ae2f47b1f5cf7548db
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:13ZDavid Bremnerdavid@tethera.net2019-04-21T23:41:34Zurn:sha1:40b025c5f1cc3dafe4c30cd6005fdb2ba32e0c95
This will still generate a warning about an excluded document in the
toctree, but it cuts down on the noise quite a lot.
bump copyright year2019-02-01T12:08:13ZDavid Bremnerdavid@tethera.net2019-02-01T12:08:13Zurn:sha1:32fb3c420a408ccfd20301f0c527c4259bf721ccdoc: add 2018 to copyright year2018-01-02T01:17:05ZDavid Bremnerdavid@tethera.net2018-01-02T01:17:05Zurn:sha1:b75797150bbace2ade518a669dbd6b0f0f76bebedoc: add notmuch-properties(7)2017-10-21T22:52:55ZDaniel Kahn Gillmordkg@fifthhorseman.net2017-10-21T02:25:39Zurn:sha1:6575b7eb31a710c8215be698d5cf31be20d4356e
We will want a user-facing place to record details about the use of
notmuch properties shortly. This establishes a new manual page for
that purpose.