<p dir="ltr"><br>
On Jan 18, 2015 6:56 PM, "David Bremner" <<a href="mailto:david@tethera.net">david@tethera.net</a>> wrote:<br>
><br>
> It was becoming increasingly complicated to support rst2man, and there<br>
> were apparently not many people that relied on it.<br>
> ---<br>
><br>
> Now's your chance to tell us how useful rst2man support is to you.<br>
><br>
> INSTALL | 7 ++----<br>
> NEWS | 6 +++++<br>
> configure | 20 +++--------------<br>
> doc/INSTALL | 13 -----------<br>
> doc/Makefile.local | 7 ++----<br>
> doc/prerst2man.py | 64 ------------------------------------------------------<br>
> 6 files changed, 13 insertions(+), 104 deletions(-)<br>
> delete mode 100644 doc/prerst2man.py<br>
><br>
> diff --git a/INSTALL b/INSTALL<br>
> index b543c50..eaccd93 100644<br>
> --- a/INSTALL<br>
> +++ b/INSTALL<br>
> @@ -75,14 +75,11 @@ Talloc, and zlib which are each described below:<br>
> Building Documentation<br>
> ----------------------<br>
><br>
> -By default the documentation for notmuch is built using sphinx.<br>
> +To build the documentation for notmuch you need at least version 1.0<br>
> +of sphinx (Jul. 2010).<br>
><br>
> Sphinx is available from <a href="http://www.sphinx-doc.org">www.sphinx-doc.org</a>.<br>
><br>
> -If you prefer, you can build the man pages using rst2man, from the<br>
> -python docutils package. See doc/INSTALL for details.<br>
> -<br>
> -<br>
> Installing Dependencies from Packages<br>
> -------------------------------------<br>
><br>
> diff --git a/NEWS b/NEWS<br>
> index abb5ad7..53e06aa 100644<br>
> --- a/NEWS<br>
> +++ b/NEWS<br>
> @@ -1,5 +1,11 @@<br>
> Notmuch 0.20 (UNRELEASED)<br>
><br>
> +Documentation<br>
> +-------------<br>
> +<br>
> +Support for using rst2man in place of sphinx to build the<br>
> +docmumentation has been removed.</p>
<p dir="ltr">-mu</p>
<p dir="ltr">Otherwise lgtm.</p>
<p dir="ltr">Jani.<br></p>
<p dir="ltr">> +<br>
> Contrib<br>
> -------<br>
><br>
> diff --git a/configure b/configure<br>
> index 137acea..a6b49ae 100755<br>
> --- a/configure<br>
> +++ b/configure<br>
> @@ -447,19 +447,9 @@ printf "Checking if sphinx is available and supports nroff output... "<br>
> if hash sphinx-build > /dev/null 2>&1 && ${python} -m sphinx.writers.manpage > /dev/null 2>&1 ; then<br>
> printf "Yes.\n"<br>
> have_sphinx=1<br>
> - have_rst2man=0<br>
> else<br>
> - printf "No (falling back to rst2man).\n"<br>
> + printf "No (so will not install man pages).\n"<br>
> have_sphinx=0<br>
> -<br>
> - printf "Checking if rst2man is available... "<br>
> - if rst2man -V > /dev/null 2>&1; then<br>
> - printf "Yes.\n"<br>
> - have_rst2man=1<br>
> - else<br>
> - printf "No (so will not install man pages).\n"<br>
> - have_rst2man=0<br>
> - fi<br>
> fi<br>
><br>
> libdir_in_ldconfig=0<br>
> @@ -848,9 +838,6 @@ HAVE_EMACS = ${have_emacs}<br>
> # Whether there's a sphinx-build binary available for building documentation<br>
> HAVE_SPHINX=${have_sphinx}<br>
><br>
> -# Whether there's a rst2man binary available for building documentation<br>
> -HAVE_RST2MAN=${have_rst2man}<br>
> -<br>
> # Whether there's a doxygen binary available for building api documentation<br>
> HAVE_DOXYGEN=${have_doxygen}<br>
><br>
> @@ -978,9 +965,8 @@ cat > sh.config <<EOF<br>
> # Whether the Xapian version in use supports compaction<br>
> NOTMUCH_HAVE_XAPIAN_COMPACT=${have_xapian_compact}<br>
><br>
> -# Whether there's either sphinx or rst2man available for building<br>
> -# documentation<br>
> -NOTMUCH_HAVE_MAN=$((have_sphinx || have_rst2man))<br>
> +# do we have man pages?<br>
> +NOTMUCH_HAVE_MAN=$((have_sphinx))<br>
><br>
> # Name of python interpreter<br>
> NOTMUCH_PYTHON=${python}<br>
> diff --git a/doc/INSTALL b/doc/INSTALL<br>
> index e37c2b9..0585476 100644<br>
> --- a/doc/INSTALL<br>
> +++ b/doc/INSTALL<br>
> @@ -1,9 +1,6 @@<br>
> This file contains some more detailed information about building and<br>
> installing the documentation.<br>
><br>
> -Building with sphinx.<br>
> ----------------------<br>
> -<br>
> - You need sphinx at least version 1.0.<br>
><br>
> - You can build build and install man pages with 'make install-man'<br>
> @@ -12,13 +9,3 @@ Building with sphinx.<br>
> (currently only the man pages) with<br>
><br>
> 'make install-{man|info|html|pdf}'<br>
> -<br>
> -Building the man pages<br>
> -----------------------<br>
> -<br>
> -- You can build the man pages with rst2man (from python-docutils) with<br>
> - 'make rst2man'.<br>
> -<br>
> -- Currently there is no support to automagically install the resulting<br>
> - nroff files, but it should work to modify the target install-man<br>
> - in doc/Makefile.local.<br>
> diff --git a/doc/Makefile.local b/doc/Makefile.local<br>
> index e7d0bac..0bdf2e1 100644<br>
> --- a/doc/Makefile.local<br>
> +++ b/doc/Makefile.local<br>
> @@ -7,7 +7,6 @@ SPHINXOPTS := -q<br>
> SPHINXBUILD = sphinx-build<br>
> DOCBUILDDIR := $(dir)/_build<br>
><br>
> -prerst2man := python $(srcdir)/$(dir)/prerst2man.py<br>
> mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py<br>
><br>
> # Internal variables.<br>
> @@ -50,8 +49,6 @@ ifeq ($(HAVE_SPHINX),1)<br>
> mkdir -p $(DOCBUILDDIR)/man/man$${section}; \<br>
> mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \<br>
> done<br>
> -else ifeq ($(HAVE_RST2MAN),1)<br>
> - $(prerst2man) $(srcdir)/doc $(DOCBUILDDIR)/man<br>
> else<br>
> @echo "Fatal: build dependency fail."<br>
> @false<br>
> @@ -79,10 +76,10 @@ endif<br>
><br>
> # Do not try to build or install man pages if a man page converter is<br>
> # not available.<br>
> -ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00)<br>
> +ifeq ($(HAVE_SPHINX),0)<br>
> build-man:<br>
> install-man:<br>
> - @echo "No sphinx or rst2man, will not install man pages."<br>
> + @echo "No sphinx, will not install man pages."<br>
> else<br>
> build-man: ${MAN_GZIP_FILES}<br>
> install-man: ${MAN_GZIP_FILES}<br>
> diff --git a/doc/prerst2man.py b/doc/prerst2man.py<br>
> deleted file mode 100644<br>
> index 968722a..0000000<br>
> --- a/doc/prerst2man.py<br>
> +++ /dev/null<br>
> @@ -1,64 +0,0 @@<br>
> -from sys import argv<br>
> -from datetime import date<br>
> -from os.path import dirname, isdir<br>
> -from os import makedirs, system<br>
> -import re<br>
> -<br>
> -sourcedir = argv[1]<br>
> -outdir = argv[2]<br>
> -<br>
> -if not isdir(outdir):<br>
> - makedirs(outdir, 0o755)<br>
> -<br>
> -with open(sourcedir + "/conf.py") as cf:<br>
> - exec(cf.read())<br>
> -<br>
> -<br>
> -def header(file, startdocname, command, description, authors, section):<br>
> - file.write("""<br>
> -{0:s}<br>
> -{1:s}<br>
> -{2:s}<br>
> -<br>
> -:Date: {3:s}<br>
> -:Version: {4:s}<br>
> -:Manual section: {5:d}<br>
> -:Manual group: {6:s}<br>
> -<br>
> -""".format(<br>
> -'-' * len(description),<br>
> -description,<br>
> -'-' * len(description),<br>
> -date.today().isoformat(), release, section, project))<br>
> -<br>
> -blankre = re.compile("^\s*$")<br>
> -for page in man_pages:<br>
> - outdirname = outdir + '/' + dirname(page[0])<br>
> - if not isdir(outdirname):<br>
> - makedirs(outdirname, 0o755)<br>
> - filename = outdir + '/' + page[0] + '.rst'<br>
> - outfile = open(filename, 'w')<br>
> - infile = open(sourcedir + '/' + page[0] + '.rst', 'r')<br>
> -<br>
> - # this is a crude hack. We look for the first blank line, and<br>
> - # insert the rst2man header there.<br>
> - #<br>
> - # XXX consider really parsing input<br>
> -<br>
> - count = 0<br>
> - lines = infile.readlines()<br>
> - for line in lines:<br>
> - outfile.write(line)<br>
> - if (blankre.match(line)):<br>
> - break<br>
> - count = count + 1<br>
> -<br>
> - del lines[0:count + 1]<br>
> -<br>
> - header(outfile, *page)<br>
> -<br>
> - outfile.write("".join(lines))<br>
> - outfile.close()<br>
> -<br>
> - system('set -x; rst2man {0} {1}/{2}.{3}'<br>
> - .format(filename, outdir, page[0], page[4]))<br>
> --<br>
> 2.1.4<br>
><br>
> _______________________________________________<br>
> notmuch mailing list<br>
> <a href="mailto:notmuch@notmuchmail.org">notmuch@notmuchmail.org</a><br>
> <a href="http://notmuchmail.org/mailman/listinfo/notmuch">http://notmuchmail.org/mailman/listinfo/notmuch</a><br>
</p>