From: "W. Trevor King" <wking@tremily.us>
To: notmuch@notmuchmail.org
Subject: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates
Date: Sat, 5 Apr 2014 10:31:11 -0700 [thread overview]
Message-ID: <edf9a674bc1f41917caead8d38b5f09295a9d1bd.1396718720.git.wking@tremily.us> (raw)
In-Reply-To: <cover.1396718720.git.wking@tremily.us>
In-Reply-To: <cover.1396718720.git.wking@tremily.us>
The rst2man target was removed in 9d9a700 (doc: build man pages at
build time; introduce HAVE_SPHINX, HAVE_RST2MAN, 2014-03-13), but a
reference in the install docs slipped through. While I was removing
that reference, I also:
* Converted doc/INSTALL to reStructuredText, so I can link to Sphinx
and Docutils directly. Not everyone has access to Debian's
python-docutils, so it's better to be genric here.
* Converted from an unordered list to paragraphs, because I think it
flows better.
* Dropped the rst2man no-automatic-install caveat. I don't think this
applies to the current code, although I haven't tried to track down
a commit that adds the automatic-install support. Anyhow,
$ make HAVE_SPHINX=0 RST2MAN=/usr/bin/rst2man.py DESTDIR=/tmp/ install-man
works for me.
---
doc/INSTALL | 34 ++++++++++++++++++++--------------
1 file changed, 20 insertions(+), 14 deletions(-)
diff --git a/doc/INSTALL b/doc/INSTALL
index e37c2b9..91222f9 100644
--- a/doc/INSTALL
+++ b/doc/INSTALL
@@ -1,24 +1,30 @@
This file contains some more detailed information about building and
installing the documentation.
-Building with sphinx.
----------------------
+Building with Sphinx
+--------------------
-- You need sphinx at least version 1.0.
+With Sphinx_ version 1.0 or greater, you can build man, info, html,
+and pdf versions of the docs (currently only the man pages) with::
-- You can build build and install man pages with 'make install-man'
+ make build-{man|info|html|pdf}
-- You can build man, info, html, and pdf versions of the docs
- (currently only the man pages) with
+You can build build and install the docs (currently only the man
+pages) with::
- 'make install-{man|info|html|pdf}'
+ make install-{man|info|html|pdf}
-Building the man pages
-----------------------
+Building the man Docutils
+-------------------------
-- You can build the man pages with rst2man (from python-docutils) with
- 'make rst2man'.
+If you don't have Sphinx installed, you can still build the man-page
+version of the docs using rst2man (from Docutils_)::
-- Currently there is no support to automagically install the resulting
- nroff files, but it should work to modify the target install-man
- in doc/Makefile.local.
+ make build-man
+
+and install with::
+
+ make install-man
+
+.. _Sphinx: http://sphinx-doc.org/
+.. _Docutils: http://docutils.sourceforge.net/
--
1.9.1.353.gc66d89d
next prev parent reply other threads:[~2014-04-05 17:31 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-04-05 17:31 [PATCH 0/7] doc: Python 3 compat, rst2man.py support, etc W. Trevor King
2014-04-05 17:31 ` [PATCH 1/7] doc/mkdocdeps.py: Convert execfile to import W. Trevor King
2014-04-05 17:31 ` [PATCH 2/7] doc/mkdocdeps.py: Use "with" statement for the output file W. Trevor King
2014-04-05 17:31 ` [PATCH 3/7] doc/prerst2man.py: Use Python-3-compatible octal notation W. Trevor King
2014-04-05 17:31 ` [PATCH 4/7] doc/prerst2man.py: Fix 'os.system' -> 'system' typo W. Trevor King
2014-04-05 17:31 ` [PATCH 5/7] doc: Allow rst2man.py as an alternative to rst2man W. Trevor King
2014-04-05 19:05 ` Tomi Ollila
2014-04-05 19:19 ` W. Trevor King
2014-04-06 8:37 ` Tomi Ollila
2014-04-05 17:31 ` [PATCH 6/7] doc/prerst2man.py: Convert execfile to import W. Trevor King
2014-04-05 17:31 ` W. Trevor King [this message]
2014-04-05 20:35 ` [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates David Bremner
2014-04-05 21:12 ` W. Trevor King
2014-04-05 22:53 ` David Bremner
2014-04-06 8:18 ` Tomi Ollila
2014-04-14 18:00 ` [PATCH 0/7] doc: Python 3 compat, rst2man.py support, etc Tomi Ollila
2014-04-20 22:56 ` David Bremner
2014-04-21 13:03 ` David Bremner
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=edf9a674bc1f41917caead8d38b5f09295a9d1bd.1396718720.git.wking@tremily.us \
--to=wking@tremily.us \
--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).