source: git/doc/Makefile.am @ d1aefbc

stereo-2025warn-only-for-hanging-survey
Last change on this file since d1aefbc was d1aefbc, checked in by Olly Betts <olly@…>, 12 months ago

Convert manual from docbook to reStructured Text

The text-based format is much easier for making changes, and
for users the output from sphinx looks nicer and has extra
features (like built-in "Quick search" in the HTML output).

The plain text version of the manual is no longer generated.
Sphinx can produce one but the .rst sources actually seem
more readable for anyone wanting to read the manual in plain
text.

The extra targets to generate the manual in RTF and PostScript?
have been dropped as I doubt they are still used (we stopped
providing them on the website years ago). They could probably be
reinstated if they are still use.

As part of converting, the formatting of the manual has been
made more consistent. Some content has also been reordered, and
other minor improvements made.

  • Property mode set to 100644
File size: 2.6 KB
Line 
1## Process this file with automake to produce Makefile.in
2
3pkgdocdir = @PKGDOCDIR@
4
5man_sources = \
6    aven.rst \
7    cavern.rst \
8    diffpos.rst \
9    dump3d.rst \
10    extend.rst \
11    sorterr.rst \
12    survexport.rst \
13    survex.rst
14
15manual_sources = \
16    index.rst \
17    intro.rst \
18    getstart.rst \
19    cmdline.rst \
20    $(man_sources) \
21    datafile.rst \
22    svxhowto.rst \
23    genhowto.rst \
24    compass.rst \
25    maillist.rst \
26    walls.rst \
27    cmap.rst \
28    future.rst
29
30manual_alt = manual.pdf
31
32HTMLFILES= AUTHORS.htm HACKING.htm NEWS.htm OLDNEWS.htm TODO.htm index.htm \
33 3dformat.htm 3dformat-old.htm
34
35NEWS.htm: ../NEWS news2html.pl
36        ./news2html.pl '@PRETTYPACKAGE@ @VERSION@' < ../NEWS > NEWS.htm
37
38OLDNEWS.htm: ../OLDNEWS news2html.pl
39        ./news2html.pl < ../OLDNEWS > OLDNEWS.htm
40
41MAINTAINERCLEANFILES = $(manual_alt) NEWS.htm OLDNEWS.htm
42
43pkgdoc_DATA = $(HTMLFILES) $(manual_alt)
44
45man_MANS = \
46    aven.1 \
47    cavern.1 \
48    diffpos.1 \
49    dump3d.1 \
50    extend.1 \
51    sorterr.1 \
52    survexport.1 \
53    survex.7
54
55EXTRA_DIST = $(HTMLFILES) manual $(manual_alt) \
56 $(manual_sources) conf.py \
57 $(man_MANS) \
58 news2html.pl
59
60# Export these as an environment variables for use by conf.py
61export PKGDOCDIR_EXPANDED
62export VERSION
63
64$(man_MANS): $(man_sources) ../configure.ac
65        [ -d man.tmp ] || mkdir man.tmp
66        $(SPHINX_BUILD) -b man $(srcdir) man.tmp $<
67        mv man.tmp/*.1 man.tmp/*.7 .
68        rm -rf man.tmp
69
70install-data-local: manual
71        $(mkinstalldirs) $(DESTDIR)$(pkgdocdir)/manual/_static
72        test ! -d manual -a -d "$(srcdir)/manual" && cd $(srcdir) ; \
73        for p in manual/*.htm manual/*.js manual/_static/*.js manual/_static/*.css ; do \
74          echo " $(INSTALL_DATA) $$p $(DESTDIR)$(pkgdocdir)/$$p"; \
75          $(INSTALL_DATA) $$p $(DESTDIR)$(pkgdocdir)/$$p; \
76        done
77
78uninstall-local:
79        test ! -d manual -a -d "$(srcdir)/manual" && cd $(srcdir) ; \
80        for p in manual/*.htm manual/*.js manual/_static/*.js manual/_static/*.css ; do \
81          echo " rm -f $(DESTDIR)$(pkgdocdir)/$$p"; \
82          rm -f $(DESTDIR)$(pkgdocdir)/$$p; \
83        done
84        -rmdir $(DESTDIR)$(pkgdocdir)/manual/_static
85        -rmdir $(DESTDIR)$(pkgdocdir)/manual
86
87maintainer-clean-local:
88        rm -rf manual "$(srcdir)/manual"
89
90manual: manual/stampfile ../configure.ac
91manual/stampfile: $(manual_sources)
92        rm -rf manual
93        $(SPHINX_BUILD) -b html . manual
94        touch manual/stampfile
95
96manual.pdf: $(manual_sources) ../configure.ac
97        $(SPHINX_BUILD) -M latexpdf $(srcdir) manual.latex
98        mv manual.latex/latex/survex.pdf manual.pdf
99        rm -rf manual.latex
100
101# The rules below aren't used by the build system - they're for "manual" use
102# (ho ho)
103
104manual.html: $(manual_sources) ../configure.ac
105        $(SPHINX_BUILD) -b singlehtml . tmpx
Note: See TracBrowser for help on using the repository browser.