From b6dc9d33488899b73c78675f5357afabf8f8fd29 Mon Sep 17 00:00:00 2001
From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Date: Thu, 9 Jun 2022 13:43:14 -0400
Subject: doc: Replace texi2html with makeinfo to generate HTML doc.

One benefit of using 'makeinfo' instead of 'texi2html' is that the
HTML file hierarchy layout produced by 'makeinfo' matches the layout
expected for cross-reference URLs.

For example, a cross-reference defined via:

  @pxref{Introduction,,, geiser, Geiser User Manual}

would produce the URL: /Introduction.html#Introduction, while
Texi2html produces /geiser/geiser_1.html#Introduction instead,
breaking for example a cross-reference in the GNU Guix Reference
Manual (see: https://issues.guix.gnu.org/55290).

* doc/makefile (web): Replace texi2html with makeinfo.
* doc/site.conf: Delete file.
* doc/web.texi: Likewise.
---
 doc/makefile  | 17 ++++++++---------
 doc/site.conf | 55 -------------------------------------------------------
 doc/web.texi  | 43 -------------------------------------------
 3 files changed, 8 insertions(+), 107 deletions(-)
 delete mode 100644 doc/site.conf
 delete mode 100644 doc/web.texi

(limited to 'doc')

diff --git a/doc/makefile b/doc/makefile
index 6f2a779..fd25e55 100644
--- a/doc/makefile
+++ b/doc/makefile
@@ -18,15 +18,14 @@ clean:
 
 web:
 	rm -f $(output_dir)/*.html
-	texi2html --output=$(output_dir) \
-                  --split=chapter \
-                  --noheader \
-                  --nonumber-section \
-                  --init-file=$(top_srcdir)/doc/site.conf \
-                  --top-file=index.html \
-                  $(top_srcdir)/doc/web.texi
-	cp $(top_srcdir)/doc/geiser.css ${output_dir}
-	cp -r $(top_srcdir)/doc/img ${output_dir}
+	makeinfo --output=$(output_dir) \
+	  --html \
+	  --css-include=$(CURDIR)/geiser.css \
+	  --no-headers \
+	  --no-number-sections \
+	  --split=chapter \
+	  $(CURDIR)/geiser.texi && \
+	cp -r $(CURDIR)/img ${output_dir}
 
 http: web
 	cd $(output_dir) && python -m http.server $(port)
diff --git a/doc/site.conf b/doc/site.conf
deleted file mode 100644
index c8b55a9..0000000
--- a/doc/site.conf
+++ /dev/null
@@ -1,55 +0,0 @@
-# -*- perl -*-
-
-$DO_CONTENTS = 0;
-$DO_SCONTENTS = 0;
-$PREFIX = geiser;
-$NODE_FILES = 0;
-$SEPARATED_FOOTNOTES = 0;
-
-@MISC_BUTTONS = ();
-@CHAPTER_BUTTONS = ('FastBack', 'FastForward', 'Top');
-
-$USER = 'jao';
-$DATE = '';
-
-$CSS_LINES = '<link rel="stylesheet" type="text/css" href="./geiser.css">';
-
-$print_page_foot = \&page_foot;
-$print_chapter_footer = \&chap_footer;
-$print_chapter_header = \&chap_header;
-
-sub page_foot($) {
-    my $h = shift;
-    print $h "</body>";
-}
-
-sub button_link {
-    my $label = shift;
-    my $txt = shift;
-    my $trail = shift;
-   '<a class="navlink" href="' . $Texi2HTML::HREF{$label} . '">'
-       . $txt . '</a>' . $trail;
-}
-
-$jao_navigation_links = '';
-
-sub chap_header {
-    my $fh = shift;
-    $jao_navigation_links = nav_links();
-    print $fh "<hr>";
-}
-
-sub chap_footer {
-    my $fh = shift;
-    print $fh $jao_navigation_links;
-}
-
-sub nav_links {
-    '<div class="navigation"><table border="0"><tr><td align="left">'
-        . button_link('Top', 'Geiser', '</td><td align="right">')
-        . button_link('FastBack', '<', '&nbsp;&nbsp;')
-        . button_link('FastForward', '>', '</td></tr></table></div>');
-}
-
-1;
-
diff --git a/doc/web.texi b/doc/web.texi
deleted file mode 100644
index 6761db5..0000000
--- a/doc/web.texi
+++ /dev/null
@@ -1,43 +0,0 @@
-@settitle Geiser
-
-@include macros.texi
-
-@contents
-
-@node Top, Introduction, (dir), (dir)
-
-@include top.texi
-
-@menu
-* Introduction::
-* Installation::
-* The REPL::
-* Between the parens::
-* Cheat sheet::
-* No hacker is an island::
-* Index::
-@end menu
-
-@html
-<br/>
-<div class="navigation" align="right">
-<a class="navlink" href="https://gitlab.com/groups/emacs-geiser/-/issues">Bugs</a>&nbsp;&nbsp;&nbsp;&nbsp;
-<a class="navlink" href="https://gitlab.com/emacs-geiser">Source</a>&nbsp;&nbsp;&nbsp;&nbsp;
-<a class="navlink" href="http://lists.nongnu.org/mailman/listinfo/geiser-users">Mailing list</a>&nbsp;
-</div>
-@end html
-
-@include intro.texi
-@include install.texi
-@include repl.texi
-@include parens.texi
-@include cheat.texi
-@include thanks.texi
-@include index.texi
-
-@bye
-
-@c Local Variables:
-@c mode: texinfo
-@c TeX-master: t
-@c End:
-- 
cgit v1.2.3