From d241a486facf1002b29e499c2fb96a302bfd825b Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sun, 18 Jan 2015 17:55:10 +0100 Subject: [PATCH] doc: remove support for rst2man It was becoming increasingly complicated to support rst2man, and there were apparently not many people that relied on it. --- INSTALL | 7 ++--- NEWS | 6 +++++ configure | 20 +++------------ doc/INSTALL | 13 ---------- doc/Makefile.local | 7 ++--- doc/prerst2man.py | 64 ---------------------------------------------- 6 files changed, 13 insertions(+), 104 deletions(-) delete mode 100644 doc/prerst2man.py diff --git a/INSTALL b/INSTALL index b543c508..eaccd93d 100644 --- a/INSTALL +++ b/INSTALL @@ -75,14 +75,11 @@ Talloc, and zlib which are each described below: Building Documentation ---------------------- -By default the documentation for notmuch is built using sphinx. +To build the documentation for notmuch you need at least version 1.0 +of sphinx (Jul. 2010). Sphinx is available from www.sphinx-doc.org. -If you prefer, you can build the man pages using rst2man, from the -python docutils package. See doc/INSTALL for details. - - Installing Dependencies from Packages ------------------------------------- diff --git a/NEWS b/NEWS index abb5ad7a..53e06aa6 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,11 @@ Notmuch 0.20 (UNRELEASED) +Documentation +------------- + +Support for using rst2man in place of sphinx to build the +docmumentation has been removed. + Contrib ------- diff --git a/configure b/configure index 137aceab..a6b49ae4 100755 --- a/configure +++ b/configure @@ -447,19 +447,9 @@ printf "Checking if sphinx is available and supports nroff output... " if hash sphinx-build > /dev/null 2>&1 && ${python} -m sphinx.writers.manpage > /dev/null 2>&1 ; then printf "Yes.\n" have_sphinx=1 - have_rst2man=0 else - printf "No (falling back to rst2man).\n" + printf "No (so will not install man pages).\n" have_sphinx=0 - - printf "Checking if rst2man is available... " - if rst2man -V > /dev/null 2>&1; then - printf "Yes.\n" - have_rst2man=1 - else - printf "No (so will not install man pages).\n" - have_rst2man=0 - fi fi libdir_in_ldconfig=0 @@ -848,9 +838,6 @@ HAVE_EMACS = ${have_emacs} # Whether there's a sphinx-build binary available for building documentation HAVE_SPHINX=${have_sphinx} -# Whether there's a rst2man binary available for building documentation -HAVE_RST2MAN=${have_rst2man} - # Whether there's a doxygen binary available for building api documentation HAVE_DOXYGEN=${have_doxygen} @@ -978,9 +965,8 @@ cat > sh.config <