Re: [RFC Patch] start of sphinx based docs

Subject: Re: [RFC Patch] start of sphinx based docs

Date: Sun, 19 Jan 2014 14:57:26 -0400

To: Tomi Ollila, notmuch@notmuchmail.org

Cc:

From: David Bremner


Tomi Ollila <tomi.ollila@iki.fi> writes:

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

That should be easy to fix. Whoevery posted that patch was incredibly
lazy ;).

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

It's definitely a concern. We could fall back to python-docutils to
generate the manpages, since there is a standalone rst2man script there.
There are some incompatibilities about how the TH line is generated, but
I think those could be hacked around, if people thought it was worth it.

d

Thread: