unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: Tomi Ollila <tomi.ollila@iki.fi>, notmuch@notmuchmail.org
Subject: Re: [RFC Patch] start of sphinx based docs
Date: Sun, 19 Jan 2014 14:57:26 -0400	[thread overview]
Message-ID: <87vbxfkdex.fsf@zancas.localnet> (raw)
In-Reply-To: <m2k3dw6q0y.fsf@guru.guru-group.fi>

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

  reply	other threads:[~2014-01-19 18:57 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 [this message]
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           ` v3 of sphinx docs Mark Walters

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=87vbxfkdex.fsf@zancas.localnet \
    --to=david@tethera.net \
    --cc=notmuch@notmuchmail.org \
    --cc=tomi.ollila@iki.fi \
    /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).