2016-02-21 13:21:41 +03:00
|
|
|
#!/usr/bin/env stack
|
2016-04-06 01:23:20 +03:00
|
|
|
{- stack runghc --verbosity info
|
2016-04-05 16:59:52 +03:00
|
|
|
--package base-prelude
|
|
|
|
--package directory
|
|
|
|
--package extra
|
|
|
|
--package here
|
|
|
|
--package safe
|
|
|
|
--package shake
|
|
|
|
--package time
|
2016-04-06 01:23:20 +03:00
|
|
|
--package pandoc
|
2016-04-05 16:59:52 +03:00
|
|
|
-}
|
|
|
|
{-
|
|
|
|
Usage: see below.
|
|
|
|
Shake.hs is a more powerful Makefile, providing a number of commands
|
|
|
|
for performing useful tasks. Compiling this script is suggested, so that
|
|
|
|
it runs quicker and will not be affected eg when exploring old code versions.
|
|
|
|
More about Shake: http://shakebuild.com/manual
|
|
|
|
Requires: https://www.haskell.org/downloads#stack
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2016-04-05 16:59:52 +03:00
|
|
|
Shake notes:
|
|
|
|
wishlist:
|
2016-04-07 18:52:41 +03:00
|
|
|
just one shake import
|
2016-04-05 16:59:52 +03:00
|
|
|
wildcards in phony rules
|
|
|
|
multiple individually accessible wildcards
|
2016-04-07 18:52:41 +03:00
|
|
|
not having to write :: Action ExitCode after a non-final cmd
|
2016-04-05 16:59:52 +03:00
|
|
|
-}
|
|
|
|
|
|
|
|
{-# LANGUAGE PackageImports, QuasiQuotes #-}
|
|
|
|
|
|
|
|
import Prelude ()
|
|
|
|
import "base-prelude" BasePrelude
|
|
|
|
-- import "base" System.Console.GetOpt
|
|
|
|
import "extra" Data.List.Extra
|
|
|
|
import "here" Data.String.Here
|
|
|
|
import "safe" Safe
|
|
|
|
import "shake" Development.Shake
|
|
|
|
import "shake" Development.Shake.FilePath
|
|
|
|
import "time" Data.Time
|
|
|
|
import "directory" System.Directory as S (getDirectoryContents)
|
|
|
|
|
|
|
|
usage = [i|Usage:
|
2016-04-06 01:56:14 +03:00
|
|
|
./Shake.hs compile # compile this script (optional)
|
|
|
|
./Shake --help # show options, eg --color
|
2016-04-06 02:07:37 +03:00
|
|
|
./Shake # show commands
|
2016-04-07 18:52:41 +03:00
|
|
|
./Shake site # generate things needed for the website
|
2016-04-06 01:56:14 +03:00
|
|
|
./Shake manpages # generate nroff files for man
|
|
|
|
./Shake webmanpages # generate web man pages for hakyll
|
2016-04-07 18:52:41 +03:00
|
|
|
./Shake webmanual # generate combined web man page for hakyll
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
./Shake m4manpages # generate nroff files for man (alternate method)
|
|
|
|
./Shake m4webmanpages # generate web man pages for hakyll (alternate method)
|
2016-04-05 16:59:52 +03:00
|
|
|
|]
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2016-04-06 01:56:14 +03:00
|
|
|
buildDir = ".build"
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
pandoc =
|
|
|
|
-- "stack exec -- pandoc" -- use the pandoc required above
|
|
|
|
"pandoc" -- use pandoc in PATH (faster)
|
2016-04-07 18:52:41 +03:00
|
|
|
manpages = [ -- in suggested reading order
|
|
|
|
"hledger.1"
|
2016-02-21 13:21:41 +03:00
|
|
|
,"hledger-ui.1"
|
|
|
|
,"hledger-web.1"
|
2016-04-07 18:52:41 +03:00
|
|
|
,"hledger-api.1"
|
|
|
|
,"hledger_journal.5"
|
|
|
|
,"hledger_csv.5"
|
|
|
|
,"hledger_timelog.5"
|
|
|
|
,"hledger_timedot.5"
|
2016-02-21 13:21:41 +03:00
|
|
|
]
|
|
|
|
|
|
|
|
manpageDir p
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
| '_' `elem` p = "hledger-lib" </> "doc"
|
|
|
|
| otherwise = dropExtension p </> "doc"
|
2016-02-21 13:21:41 +03:00
|
|
|
|
|
|
|
main = do
|
|
|
|
|
|
|
|
pandocFilters <-
|
2016-04-06 01:46:44 +03:00
|
|
|
map ("doc" </>). nub . sort . map (-<.> "") . filter ("pandoc-" `isPrefixOf`)
|
|
|
|
<$> S.getDirectoryContents "doc"
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2016-04-05 16:59:52 +03:00
|
|
|
shakeArgs
|
|
|
|
shakeOptions{
|
|
|
|
shakeFiles=buildDir
|
|
|
|
,shakeVerbosity=Loud
|
|
|
|
-- ,shakeReport=[".shake.html"]
|
|
|
|
} $ do
|
|
|
|
|
|
|
|
want ["help"]
|
|
|
|
|
|
|
|
phony "help" $ liftIO $ putStrLn usage
|
|
|
|
|
|
|
|
phony "compile" $ need ["Shake"]
|
|
|
|
"Shake" %> \out -> do
|
|
|
|
need ["Shake.hs"]
|
|
|
|
cmd "stack ghc Shake.hs" :: Action ExitCode
|
|
|
|
putLoud "Compiled ./Shake, you can now use this instead of ./Shake.hs"
|
|
|
|
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
-- docs
|
|
|
|
|
2016-04-07 18:52:41 +03:00
|
|
|
phony "site" $ need [
|
2016-04-06 02:16:38 +03:00
|
|
|
"manpages"
|
|
|
|
,"webmanpages"
|
2016-04-07 18:52:41 +03:00
|
|
|
,"m4manpages"
|
|
|
|
,"m4webmanpages"
|
|
|
|
,"site/manual2.md"
|
2016-04-06 02:16:38 +03:00
|
|
|
]
|
|
|
|
|
2016-04-07 18:52:41 +03:00
|
|
|
-- man pages
|
|
|
|
-- method 1:
|
|
|
|
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
-- pandoc filters, these adjust master md files for web or man output
|
|
|
|
phony "pandocfilters" $ need pandocFilters
|
|
|
|
pandocFilters |%> \out -> do
|
|
|
|
need [out <.> "hs"]
|
|
|
|
cmd ("stack ghc") out
|
2016-02-21 13:21:41 +03:00
|
|
|
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
-- man pages adjusted for man and converted to nroff, by pandoc
|
2016-04-06 02:07:37 +03:00
|
|
|
let manpageNroffs = [manpageDir p </> p | p <- manpages]
|
|
|
|
phony "manpages" $ need manpageNroffs
|
|
|
|
manpageNroffs |%> \out -> do
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
let md = out <.> "md"
|
|
|
|
tmpl = "doc/manpage.nroff"
|
2016-02-21 13:21:41 +03:00
|
|
|
need $ md : tmpl : pandocFilters
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
cmd pandoc md "-s --template" tmpl "-o" out
|
2016-04-06 18:20:27 +03:00
|
|
|
"--filter doc/pandoc-drop-web-blocks"
|
2016-04-06 01:46:44 +03:00
|
|
|
"--filter doc/pandoc-drop-html-blocks"
|
|
|
|
"--filter doc/pandoc-drop-html-inlines"
|
|
|
|
"--filter doc/pandoc-drop-links"
|
|
|
|
"--filter doc/pandoc-drop-notes"
|
|
|
|
"--filter doc/pandoc-capitalize-headers"
|
2016-02-21 13:21:41 +03:00
|
|
|
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
-- man pages adjusted for web by pandoc (ready for hakyll)
|
|
|
|
let webManpageMds = ["site" </> p <.>".md" | p <- manpages]
|
2016-04-06 02:07:37 +03:00
|
|
|
phony "webmanpages" $ need webManpageMds
|
|
|
|
webManpageMds |%> \out -> do
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
let p = dropExtension $ takeFileName out
|
|
|
|
md = manpageDir p </> p <.> "md"
|
|
|
|
need $ md : pandocFilters
|
2016-04-07 18:52:41 +03:00
|
|
|
cmd pandoc md "-o" out
|
|
|
|
"--filter doc/pandoc-demote-headers"
|
|
|
|
-- "--filter doc/pandoc-add-toc"
|
|
|
|
-- "--filter doc/pandoc-drop-man-blocks"
|
2016-02-21 13:21:41 +03:00
|
|
|
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
-- method 2:
|
2016-04-06 01:40:59 +03:00
|
|
|
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
-- man pages assembled from parts and adjusted for man with m4, adjusted more and converted to nroff with pandoc
|
|
|
|
let m4manpageNroffs = [manpageDir p </> "m4-"++p | p <- ["hledger.1"]]
|
|
|
|
phony "m4manpages" $ need m4manpageNroffs
|
|
|
|
m4manpageNroffs |%> \out -> do -- hledger/doc/m4-hledger.1
|
|
|
|
let (dir,file) = splitFileName out -- hledger/doc, m4-hledger.1
|
|
|
|
m4src = dir </> drop 3 file <.> "md" <.> "m4" -- hledger/doc/hledger.1.md.m4
|
2016-04-06 18:51:14 +03:00
|
|
|
m4includes = map (dir </>) ["description.md","examples.md","queries.md","commands.md","options.md"]
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
m4lib = "doc/lib.m4"
|
|
|
|
tmpl = "doc/manpage.nroff"
|
2016-04-06 18:51:14 +03:00
|
|
|
need $ m4src : m4lib : tmpl : pandocFilters ++ m4includes
|
2016-04-07 18:52:41 +03:00
|
|
|
cmd Shell "m4 -P" "-DMAN" "-I" dir m4lib m4src
|
|
|
|
"|" pandoc "-s --template" tmpl "-o" out
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
"--filter doc/pandoc-drop-html-blocks"
|
|
|
|
"--filter doc/pandoc-drop-html-inlines"
|
|
|
|
"--filter doc/pandoc-drop-links"
|
|
|
|
"--filter doc/pandoc-drop-notes"
|
|
|
|
"--filter doc/pandoc-capitalize-headers"
|
|
|
|
|
|
|
|
-- man pages assembled from parts and adjusted for web with m4, adjusted slightly more with pandoc (ready for hakyll)
|
|
|
|
let m4webManpageMds = ["site" </> "m4-"++p <.>".md" | p <- ["hledger.1"]]
|
|
|
|
phony "m4webmanpages" $ need $ m4webManpageMds
|
|
|
|
m4webManpageMds |%> \out -> do -- site/m4-hledger.1.md
|
|
|
|
let file = takeFileName out -- m4-hledger.1.md
|
|
|
|
manpage = drop 3 $ dropExtension file -- hledger.1
|
|
|
|
dir = manpageDir manpage -- hledger/doc
|
|
|
|
m4src = dir </> manpage <.> "md" <.> "m4" -- hledger/doc/hledger.1.md.m4
|
|
|
|
m4includes = map (dir </>) ["description.md","examples.md","queries.md","commands.md","options.md"]
|
|
|
|
m4lib = "doc/lib.m4"
|
|
|
|
need $ m4src : m4lib : m4includes
|
2016-04-07 18:52:41 +03:00
|
|
|
cmd Shell "m4 -P" "-DMAN -DWEB" "-I" dir m4lib m4src
|
|
|
|
"|" pandoc "-o" out
|
|
|
|
"--filter doc/pandoc-demote-headers"
|
|
|
|
-- "--filter doc/pandoc-add-toc"
|
|
|
|
|
|
|
|
-- web manual combined from man pages
|
|
|
|
|
|
|
|
let webmanual = "site/manual2.md"
|
|
|
|
phony "webmanual" $ need [ webmanual ]
|
|
|
|
"site/manual2.md" %> \out -> do
|
|
|
|
need webManpageMds
|
|
|
|
cmd Shell "printf '* toc\\n\\n' >" webmanual :: Action ExitCode
|
|
|
|
forM_ webManpageMds $ \f -> do
|
|
|
|
let manpage = dropExtension $ takeFileName f
|
|
|
|
cmd Shell ("printf '\\n## "++ manpage ++"\\n\\n' >>") webmanual :: Action ExitCode
|
|
|
|
cmd Shell "pandoc" f "-t markdown"
|
|
|
|
"--filter doc/pandoc-drop-toc"
|
|
|
|
"--filter doc/pandoc-demote-headers"
|
|
|
|
">>" webmanual :: Action ExitCode
|
2016-02-21 13:21:41 +03:00
|
|
|
|
2016-04-06 01:40:59 +03:00
|
|
|
-- cleanup
|
|
|
|
|
2016-02-21 13:21:41 +03:00
|
|
|
phony "clean" $ do
|
|
|
|
putNormal "Cleaning generated files"
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
-- removeFilesAfter "." manpageNroffs
|
|
|
|
removeFilesAfter "." m4manpageNroffs
|
2016-04-07 18:52:41 +03:00
|
|
|
removeFilesAfter "." webManpageMds
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
removeFilesAfter "." m4webManpageMds
|
2016-04-07 18:52:41 +03:00
|
|
|
removeFilesAfter "." [webmanual]
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
|
|
|
|
phony "Clean" $ do
|
|
|
|
need ["clean"]
|
2016-02-21 13:21:41 +03:00
|
|
|
putNormal "Cleaning object files"
|
doc: experimental m4-based man page build process
The new m4manpages, m4webmanpages targets generate nroff and markdown
man pages via an alternate, excitingly complicated process, involving
shake, hakyll, pandoc *and* m4. Currently just the hledger man page is
processed this way, and the output (hledger/doc/m4-hledger.1,
site/m4-hledger.1.md) is equivalent to that of the non-m4 process.
Pro: selecting and massaging web/man content may be smoother with m4
than with pandoc filters. File inclusion allows documentation to be
broken up into chunks, which may be easier to edit, reorganize and
reuse. Macros could reduce boilerplate and enable more featureful and
attractive docs.
Con: the non-m4 process was simpler, easier to for contributors to
understand and working well enough. YAGNI.
2016-04-06 18:23:12 +03:00
|
|
|
removeFilesAfter "doc" ["*.o","*.p_o","*.hi"] -- forces rebuild of exes ?
|
2016-02-21 13:21:41 +03:00
|
|
|
putNormal "Cleaning shake build files"
|
|
|
|
removeFilesAfter buildDir ["//*"]
|