From: Mark Walters <markwalters1009@gmail.com>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: v3 of sphinx docs
Date: Mon, 24 Feb 2014 00:54:29 +0000 [thread overview]
Message-ID: <87r46t49fe.fsf@qmul.ac.uk> (raw)
In-Reply-To: <1393114575-8756-1-git-send-email-david@tethera.net>
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
prev parent reply other threads:[~2014-02-24 0:54 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-18 16:00 [RFC Patch] start of sphinx based docs David Bremner
2014-01-19 13:48 ` Tomi Ollila
2014-01-19 18:57 ` David Bremner
2014-01-28 16:12 ` David Bremner
2014-01-28 16:12 ` [RFC Patch v2 1/2] doc: start of sphinx based docs David Bremner
2014-01-28 16:12 ` [RFC Patch v2 2/2] doc: add target rst2man to build man pages using rst2man David Bremner
2014-01-28 22:54 ` Mark Walters
2014-01-29 2:26 ` Re: David Bremner
2014-02-23 0:16 ` v3 of sphinx docs David Bremner
2014-02-23 0:16 ` [RFC Patch v3 1/3] doc: start of sphinx based docs David Bremner
2014-02-23 0:16 ` [RFC Patch v3 2/3] doc: add target rst2man to build man pages using rst2man David Bremner
2014-02-23 17:42 ` Tomi Ollila
2014-02-23 23:57 ` David Bremner
2014-02-23 0:16 ` [RFC Patch v3 3/3] doc: fix for conversion errors David Bremner
2014-02-24 0:54 ` Mark Walters [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r46t49fe.fsf@qmul.ac.uk \
--to=markwalters1009@gmail.com \
--cc=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).