mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-19 02:08:01 +03:00
;doc: slightly simplify dir entries, use higher-level texinfo format (#1585)
This commit is contained in:
parent
7c12c1eb00
commit
2d87298a68
19
Shake.hs
19
Shake.hs
@ -221,9 +221,9 @@ main = do
|
|||||||
|
|
||||||
-- manuals as info, ready for info (hledger/hledger.info)
|
-- manuals as info, ready for info (hledger/hledger.info)
|
||||||
infomanuals = [manualDir m </> m <.> "info" | m <- manualNames]
|
infomanuals = [manualDir m </> m <.> "info" | m <- manualNames]
|
||||||
-- an Info directory entry for each info manual (hledger/dir-entry.info)
|
-- an Info directory entry for each package's info manual (hledger/dir-entry.texi)
|
||||||
infodirentries = [manualDir m </> "dir-entry.info" | m <- manualNames]
|
infodirentries = [manualDir m </> "dir-entry.texi" | m <- manualNames]
|
||||||
-- an Info directory file which can be included with info -d or INFOPATH
|
-- a generated Info directory file for easily accessing/linking the dev version of all the info manuals
|
||||||
infodir = "dir"
|
infodir = "dir"
|
||||||
|
|
||||||
-- manuals as sphinx-ready markdown, to be rendered as part of the website (hledger/hledger.md)
|
-- manuals as sphinx-ready markdown, to be rendered as part of the website (hledger/hledger.md)
|
||||||
@ -463,12 +463,13 @@ main = do
|
|||||||
dir = takeDirectory out
|
dir = takeDirectory out
|
||||||
packagemanversionm4 = dir </> ".version.m4"
|
packagemanversionm4 = dir </> ".version.m4"
|
||||||
packagemandatem4 = dir </> ".date.m4"
|
packagemandatem4 = dir </> ".date.m4"
|
||||||
infodirentry = dir </> "dir-entry.info"
|
direntry = dir </> "dir-entry.texi"
|
||||||
-- assume any other .m4.md files in dir are included by this one XXX not true in hledger-lib
|
-- assume any other .m4.md files in dir are included by this one XXX not true in hledger-lib
|
||||||
subfiles <- liftIO $ filter (/= src) . filter (".m4.md" `isSuffixOf`) . map (dir </>) <$> S.getDirectoryContents dir
|
subfiles <- liftIO $ filter (/= src) . filter (".m4.md" `isSuffixOf`) . map (dir </>) <$> S.getDirectoryContents dir
|
||||||
need $ [src, commonm4, commandsm4, packagemanversionm4, packagemandatem4, infodirentry] ++ subfiles
|
need $ [src, commonm4, commandsm4, packagemanversionm4, packagemandatem4, direntry] ++ subfiles
|
||||||
when (dir=="hledger") $ need commandmds
|
when (dir=="hledger") $ need commandmds
|
||||||
cmd_ Shell
|
cmd_ Shell
|
||||||
|
"( cat" direntry ";"
|
||||||
m4 "-DINFOFORMAT -I" dir commonm4 commandsm4 packagemanversionm4 packagemandatem4 src "|"
|
m4 "-DINFOFORMAT -I" dir commonm4 commandsm4 packagemanversionm4 packagemandatem4 src "|"
|
||||||
-- sed "-e 's/^#(#+)/\\1/'" "|"
|
-- sed "-e 's/^#(#+)/\\1/'" "|"
|
||||||
pandoc fromsrcmd
|
pandoc fromsrcmd
|
||||||
@ -478,14 +479,8 @@ main = do
|
|||||||
-- add "standalone" headers ? sounds good for setting text encoding,
|
-- add "standalone" headers ? sounds good for setting text encoding,
|
||||||
-- but messes up quotes ('a' becomes ^Xa^Y)
|
-- but messes up quotes ('a' becomes ^Xa^Y)
|
||||||
-- "-s"
|
-- "-s"
|
||||||
"-t texinfo |"
|
"-t texinfo ) |"
|
||||||
makeinfo "-o" out
|
makeinfo "-o" out
|
||||||
-- The Info dir entry must appear before the first node;
|
|
||||||
-- not sure how better to accomplish this. Awkward. (#1585)
|
|
||||||
let tmp = out <.> "tmp"
|
|
||||||
cmd_ Shell "mv" out tmp
|
|
||||||
cmd_ Shell "cat" infodirentry tmp ">" out
|
|
||||||
cmd_ Shell "rm -f" tmp
|
|
||||||
|
|
||||||
-- Generate an Info dir file which can be included with info -d
|
-- Generate an Info dir file which can be included with info -d
|
||||||
-- or INFOPATH to add hledger menu items in Info's Directory.
|
-- or INFOPATH to add hledger menu items in Info's Directory.
|
||||||
|
@ -1,4 +0,0 @@
|
|||||||
INFO-DIR-SECTION User Applications
|
|
||||||
START-INFO-DIR-ENTRY
|
|
||||||
* hledger-ui: (hledger-ui). Terminal UI for the hledger accounting tool.
|
|
||||||
END-INFO-DIR-ENTRY
|
|
4
hledger-ui/dir-entry.texi
Normal file
4
hledger-ui/dir-entry.texi
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
@dircategory User Applications
|
||||||
|
@direntry
|
||||||
|
* hledger-ui: (hledger-ui). Terminal UI for the hledger accounting tool.
|
||||||
|
@end direntry
|
@ -1,4 +1,4 @@
|
|||||||
INFO-DIR-SECTION User Applications
|
@dircategory User Applications
|
||||||
START-INFO-DIR-ENTRY
|
@direntry
|
||||||
* hledger-web: (hledger-web). Web UI/API for the hledger accounting tool.
|
* hledger-web: (hledger-web). Web UI/API for the hledger accounting tool.
|
||||||
END-INFO-DIR-ENTRY
|
@end direntry
|
@ -1,4 +0,0 @@
|
|||||||
INFO-DIR-SECTION User Applications
|
|
||||||
START-INFO-DIR-ENTRY
|
|
||||||
* hledger: (hledger). Command-line plain text accounting tool.
|
|
||||||
END-INFO-DIR-ENTRY
|
|
4
hledger/dir-entry.texi
Normal file
4
hledger/dir-entry.texi
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
@dircategory User Applications
|
||||||
|
@direntry
|
||||||
|
* hledger: (hledger). Command-line plain text accounting tool.
|
||||||
|
@end direntry
|
Loading…
Reference in New Issue
Block a user