notmuch/doc, branch 0.18

doc/doxygen.cfg: bump version to 0.18

2014-05-03T22:38:21Z

doc: remove conf.pyc on clean

2014-04-22T05:24:04Z

This build artifict messes up the packaging process for (at least) Debian if not removed on clean.

doc: Simplify and clarify notmuch show --format=sexp description

2014-04-21T12:51:54Z

Previously, this was a verbatim copy of the --format=json text. Change it to instead reference the JSON text and actually describe how the S-expression format works.

doc: Clarify charset encoding of JSON output

2014-04-21T12:51:35Z

doc: Fix minor formatting issues in notmuch-show.rst

2014-04-21T12:51:08Z

There were some extra line breaks and missing periods.

doc: Clarify notmuch show --format=raw description

2014-04-21T12:50:57Z

In addition to being generally more precise, this is explicit that there is no charset conversion.

doc/prerst2man.py: Fix 'os.system' -> 'system' typo

2014-04-21T12:32:03Z

Avoid: $ make HAVE_SPHINX=0 HAVE_RST2MAN=1 build-man python ./doc/prerst2man.py ./doc doc/_build/man Traceback (most recent call last): File "./doc/prerst2man.py", line 65, in os.system('set -x; rst2man {0} {1}/{2}.{3}' NameError: name 'os' is not defined make: *** [doc/_build/man/man1/notmuch.1] Error 1 by using system directly. We don't need the 'os.' namespacing, because the function was imported with: from os import makedirs, system

doc/prerst2man.py: Use Python-3-compatible octal notation

2014-04-21T12:31:54Z

Python 3 only supports the 0oXXX notation for octal literals [1,2], which have also been supported in 2.x since 2.6 [2]. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#integers [2]: http://legacy.python.org/dev/peps/pep-3127/

doc/mkdocdeps.py: Use "with" statement for the output file

2014-04-21T12:31:45Z

Before this patch, the open was unnecessarily early and relied on the process cleanup to close. Neither one of these was a real problem, but PEP 343's context managers (which landed in Python 2.5) make proper cleanup very easy. [1]: http://legacy.python.org/dev/peps/pep-0343/

doc/mkdocdeps.py: Convert execfile to import

2014-04-21T12:31:36Z

excefile is gone in Python 3 [1]. Instead of exec-ing the configuration, it's easier to insert the source directory in Python's path [2], and just import the configuration. With this change, mkdocdeps.py is compatible with both Python 2 and 3. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#builtins [2]: https://docs.python.org/3/library/sys.html#sys.path