Re: v3 of sphinx docs

Subject: Re: v3 of sphinx docs

Date: Mon, 24 Feb 2014 00:54:29 +0000

To: David Bremner, notmuch@notmuchmail.org

Cc:

From: Mark Walters


This looks good to me. It will obviously need a little tweaking but I
like it.

There is some error in the conversion for SYNOPSIS for dump, restore
and tag (which may also have caused the problem for compact?)

Otherwise there were a small number of oddities in indentation, and a
general reduction in boldness (using underlining instead). (This is on a
standard xterm). One case we might care a little about is the SEE ALSO
section at the end where the underlining rather than bold seems
inconsistent with the rest of my debian manpages.

Best wishes

Mark




On Sun, 23 Feb 2014, David Bremner <david@tethera.net> wrote:
> This version includes a complete conversion of the existing manpages.
> The conversion uses doclifter + custom python code + pandoc. It is
> pretty much fully automated, so I can rebase against changes to the
> nroff source if needed.  
>
> On the other hand, it is fully automated, so there are bound to be a
> few rough spots. If there are systematic things, I can fix the
> conversion scripts; one offs can just be added to the series.
>
> It does do a much better job of option indentation than the previous
> version.
>
> I think this is reaching the point where if anybody has any strong
> objections to sphinx (with a fallback to rst2man) for the docs, I'd
> like to hear them.
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Thread: