[RFC Patch] start of sphinx based docs

[Tomi Ollila]

On Sat, Jan 18 2014, David Bremner <david at tethera.net> wrote:

> ---
>
> here is quick and dirty start a sphinx based docs.
> This has the advantage that everything is in rst, no mixed formats.
>
> things you might try, after installing sphinx (only tested with 1.2)
>
> % make -C doc man
>
> % make -C doc info
>
> % man -l doc/_build/man/notmuch-search.1
>
> % info -f doc/_build/texinfo/notmuch-emacs.info

This looks like a good plan, only Makefile & conf.py is a bit noisy
(like Jani's original Doxyfile)

Also;
centos 6$ sudo yum install python-sphinx
...
Downloading Packages:
(1/5): python-babel-0.9.4-5.1.el6.noarch.rpm             | 1.4 MB     00:07    
(2/5): python-jinja2-2.2.1-1.el6.x86_64.rpm              | 464 kB     00:02    
(3/5): python-pygments-1.1.1-1.el6.noarch.rpm            | 561 kB     00:02    
(4/5): python-setuptools-0.6.10-3.el6.noarch.rpm         | 335 kB     00:01    
(5/5): python-sphinx-0.6.6-2.el6.noarch.rpm              | 486 kB     00:02  
---------------------------------------------------------------------------
Total                                           200 kB/s | 3.2 MB     00:16

(python-docutils were already installed)
I wonder how hard it is to install these on some systems...

>
>  doc/Makefile                 | 177 ++++++++++++++++++++++++++++
>  doc/conf.py                  | 272 +++++++++++++++++++++++++++++++++++++++++++
>  doc/index.rst                |  24 ++++
>  doc/notmuch-emacs.rst        | 188 ++++++++++++++++++++++++++++++
>  doc/notmuch-search-terms.rst | 255 ++++++++++++++++++++++++++++++++++++++++
>  doc/notmuch-search.rst       | 203 ++++++++++++++++++++++++++++++++
>  doc/notmuch.rst              | 173 +++++++++++++++++++++++++++
>  7 files changed, 1292 insertions(+)
>  create mode 100644 doc/Makefile
>  create mode 100644 doc/conf.py
>  create mode 100644 doc/index.rst
>  create mode 100644 doc/notmuch-emacs.rst
>  create mode 100644 doc/notmuch-search-terms.rst
>  create mode 100644 doc/notmuch-search.rst
>  create mode 100644 doc/notmuch.rst
>