From da6718806ab5468bf63b2ebee18d0fe411013816 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sun, 25 Aug 2019 17:00:04 -0700 Subject: [PATCH] ;doc: don't add page TOCs any more, sphinx has it covered [ci skip] --- Shake.hs | 16 +++------------- doc/common.m4 | 5 ----- hledger-api/hledger-api.m4.md | 1 - hledger-lib/hledger_csv.m4.md | 1 - hledger-lib/hledger_journal.m4.md | 1 - hledger-lib/hledger_timeclock.m4.md | 1 - hledger-lib/hledger_timedot.m4.md | 1 - hledger-ui/hledger-ui.m4.md | 1 - hledger-web/hledger-web.m4.md | 1 - hledger/hledger.m4.md | 1 - tools/pandoc-drop-toc.lua | 1 + tools/pandoc-toc.lua | 2 ++ 12 files changed, 6 insertions(+), 26 deletions(-) diff --git a/Shake.hs b/Shake.hs index a6b5121b7..10a934b71 100755 --- a/Shake.hs +++ b/Shake.hs @@ -339,11 +339,10 @@ main = do phony "mdcombinedmanual" $ need [ mdcombinedmanual ] mdcombinedmanual %> \out -> do need mdmanuals - liftIO $ writeFile mdcombinedmanual $ addToc "" + liftIO $ writeFile mdcombinedmanual "" forM_ mdmanuals $ \f -> do -- site/hledger.md, site/journal.md cmd_ Shell ("printf '\\n\\n' >>") mdcombinedmanual cmd_ Shell pandoc f towebmd - "--lua-filter tools/pandoc-drop-toc.lua" "--lua-filter tools/pandoc-demote-headers.lua" ">>" mdcombinedmanual @@ -392,7 +391,6 @@ main = do -- Render one website page as html, saved in sites/_site/. -- Github-style wiki links will be hyperlinked. - -- The download page will have a TOC placeholder prepended. "site/_site//*.html" %> \out -> do let filename = takeBaseName out pagename = fileNameToPageName filename @@ -403,16 +401,13 @@ main = do | otherwise = "site" filename <.> "md" template = "site/site.tmpl" siteRoot = if "site/_site/doc//*" ?== out then "../.." else "." - maybeAddToc | isdownloadpage = addToc - | otherwise = id need [source, template] - -- read markdown source, link any wikilinks, maybe add a heading and TOC, pipe it to pandoc, write html out - Stdin . wikiLink . maybeAddToc <$> (readFile' source) >>= + -- read markdown source, link any wikilinks, pipe it to pandoc, write html out + Stdin . wikiLink <$> (readFile' source) >>= (cmd Shell pandoc "-" fromsrcmd "-t html" "--template" template ("--metadata=siteRoot:" ++ siteRoot) ("--metadata=\"title:" ++ pagename ++ "\"") - "--lua-filter=tools/pandoc-toc.lua" "-o" out ) -- This rule, for updating the live hledger.org site, gets called by: @@ -727,11 +722,6 @@ type Markdown = String addHeading :: String -> Markdown -> Markdown addHeading h = (("# "++h++"\n\n")++) --- | Prepend a table of contents placeholder. -addToc :: Markdown -> Markdown -addToc = ((tocMarker++"\n\n")++) - where tocMarker = "$TOC$" - -- | Convert Github-style wikilinks to hledger website links. wikiLink :: Markdown -> Markdown wikiLink = diff --git a/doc/common.m4 b/doc/common.m4 index 51b02f38e..0c79c11a4 100644 --- a/doc/common.m4 +++ b/doc/common.m4 @@ -31,11 +31,6 @@ m4_dnl (dev) m4_dnl )m4_dnl m4_dnl -m4_dnl Insert a table of contents marker, which doc build scripts will populate. -m4_define({{_toc_}},{{ -\$TOC\$ -}})m4_dnl -m4_dnl m4_dnl Helpers for generating table markup. m4_dnl _table_({{ m4_dnl | cell1 | cell2 ... diff --git a/hledger-api/hledger-api.m4.md b/hledger-api/hledger-api.m4.md index f1ec1e243..2281620ad 100644 --- a/hledger-api/hledger-api.m4.md +++ b/hledger-api/hledger-api.m4.md @@ -4,7 +4,6 @@ _web_({{ _docversionlinks_({{hledger-api}}) -_toc_ }}) _man_({{ diff --git a/hledger-lib/hledger_csv.m4.md b/hledger-lib/hledger_csv.m4.md index 29e94b537..5555f9ccf 100644 --- a/hledger-lib/hledger_csv.m4.md +++ b/hledger-lib/hledger_csv.m4.md @@ -4,7 +4,6 @@ _web_({{ _docversionlinks_({{csv}}) -_toc_ }}) _man_({{ diff --git a/hledger-lib/hledger_journal.m4.md b/hledger-lib/hledger_journal.m4.md index 33a3fd130..b72dd76f2 100644 --- a/hledger-lib/hledger_journal.m4.md +++ b/hledger-lib/hledger_journal.m4.md @@ -4,7 +4,6 @@ _web_({{ _docversionlinks_({{journal}}) -_toc_ }}) _man_({{ diff --git a/hledger-lib/hledger_timeclock.m4.md b/hledger-lib/hledger_timeclock.m4.md index 983b450ca..598d2871c 100644 --- a/hledger-lib/hledger_timeclock.m4.md +++ b/hledger-lib/hledger_timeclock.m4.md @@ -4,7 +4,6 @@ _web_({{ _docversionlinks_({{timeclock}}) -_toc_ }}) _man_({{ diff --git a/hledger-lib/hledger_timedot.m4.md b/hledger-lib/hledger_timedot.m4.md index fd4dc983c..83260c77d 100644 --- a/hledger-lib/hledger_timedot.m4.md +++ b/hledger-lib/hledger_timedot.m4.md @@ -4,7 +4,6 @@ _web_({{ _docversionlinks_({{timedot}}) -_toc_ }}) _man_({{ diff --git a/hledger-ui/hledger-ui.m4.md b/hledger-ui/hledger-ui.m4.md index ace88fec1..6f4f17f5b 100644 --- a/hledger-ui/hledger-ui.m4.md +++ b/hledger-ui/hledger-ui.m4.md @@ -4,7 +4,6 @@ _web_({{ _docversionlinks_({{hledger-ui}}) -_toc_ }}) _man_({{ diff --git a/hledger-web/hledger-web.m4.md b/hledger-web/hledger-web.m4.md index 3a4dc237f..59d9cf7c1 100644 --- a/hledger-web/hledger-web.m4.md +++ b/hledger-web/hledger-web.m4.md @@ -4,7 +4,6 @@ _web_({{ _docversionlinks_({{hledger-web}}) -_toc_ }}) _man_({{ diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index 258c1fdfc..0de29a3ec 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -15,7 +15,6 @@ m4_dnl hledger_troubleshooting.m4.md _web_({{ _docversionlinks_({{hledger}}) -_toc_ }}) _man_({{ diff --git a/tools/pandoc-drop-toc.lua b/tools/pandoc-drop-toc.lua index 6f0977cdf..013dc87c8 100644 --- a/tools/pandoc-drop-toc.lua +++ b/tools/pandoc-drop-toc.lua @@ -1,3 +1,4 @@ +-- Remove a $TOC$ marker (cf pandoc-toc.lua) from the document. function Para(p) if not p.content[1] then return p end if not (p.content[1].t == "Str") then return p end diff --git a/tools/pandoc-toc.lua b/tools/pandoc-toc.lua index c544a89f4..8fb5ebcb8 100644 --- a/tools/pandoc-toc.lua +++ b/tools/pandoc-toc.lua @@ -1,3 +1,5 @@ +-- Replace a $TOC$ marker with a table of contents generated from the document's headings. + local headers = {} function Header(h)