From: Tomi Ollila <tomi.ollila@iki.fi>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [RFC Patch] start of sphinx based docs
Date: Sun, 19 Jan 2014 15:48:45 +0200 [thread overview]
Message-ID: <m2k3dw6q0y.fsf@guru.guru-group.fi> (raw)
In-Reply-To: <1390060858-30905-1-git-send-email-david@tethera.net>
On Sat, Jan 18 2014, David Bremner <david@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
>
next prev parent reply other threads:[~2014-01-19 13:48 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 [this message]
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 ` 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=m2k3dw6q0y.fsf@guru.guru-group.fi \
--to=tomi.ollila@iki.fi \
--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).