From 7fbf3a9f80d1cb9e42f5bc75474c3796e01630bd Mon Sep 17 00:00:00 2001 From: Paul Garlick Date: Thu, 16 Jul 2020 17:33:01 +0100 Subject: doc: Construct info directory file. * Makefile: Add target. * doc/dir: New file. * doc/fullswof-utils.texi: Add directory entry and category. --- Makefile | 8 ++++++-- doc/dir | 19 +++++++++++++++++++ doc/fullswof-utils.texi | 5 ++++- 3 files changed, 29 insertions(+), 3 deletions(-) create mode 100644 doc/dir diff --git a/Makefile b/Makefile index 64bbe94..73b952b 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,12 @@ HTML_DIR := manual +INFO_DOC := doc/fullswof-utils.info doc/dir -all: info-doc html-doc +all: html-doc $(INFO_DOC) -info-doc: doc/fullswof-utils.texi +doc/dir: doc/fullswof-utils.info + @install-info --info-dir=doc $< + +doc/fullswof-utils.info: doc/fullswof-utils.texi @makeinfo --output=doc/fullswof-utils.info --no-split $< html-doc: doc/fullswof-utils.texi diff --git a/doc/dir b/doc/dir new file mode 100644 index 0000000..d07f6eb --- /dev/null +++ b/doc/dir @@ -0,0 +1,19 @@ +This is the file .../info/dir, which contains the +topmost node of the Info hierarchy, called (dir)Top. +The first time you invoke Info, you start off looking at this node. + +File: dir, Node: Top This is the top of the INFO tree + + This (the Directory node) gives a menu of major topics. + Typing "q" exits, "H" lists all Info commands, "d" returns here, + "h" gives a primer for first-timers, + "mEmacs" visits the Emacs manual, etc. + + In Emacs, you can click mouse button 2 on a menu item or cross reference + to select it. + +* Menu: + +Science +* FullSWOF-utils: (FullSWOF-utils). + Utility programs for the FullSWOF solver. diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi index 4e51a5e..bacfe36 100644 --- a/doc/fullswof-utils.texi +++ b/doc/fullswof-utils.texi @@ -21,7 +21,10 @@ Texts. A copy of the license is included in the section entitled @end quotation @end copying - +@dircategory Science +@direntry +* FullSWOF-utils: (FullSWOF-utils). Utility programs for the FullSWOF solver. +@end direntry @titlepage @title FullSWOF-utils Reference Manual -- cgit