diff options
| author | Albert Krewinkel <albert@zeitkraut.de> | 2017-12-29 09:58:47 +0100 |
|---|---|---|
| committer | Albert Krewinkel <albert@zeitkraut.de> | 2017-12-29 10:04:55 +0100 |
| commit | 7fa286fff1eb66ba7e2b2f6452fd06e293347d17 (patch) | |
| tree | 73d684e64e136f7e84ac6eaf31ace322f7600935 | |
| parent | 9be2c7624cb0cf3ef63516e5df959672958058bc (diff) | |
Update tool which generates lua module docs
All "helper functions" are not part of the Lua code for module pandoc,
but are added in Haskell. The respective documentation section must
therefore be excluded from automatic regeneration.
| -rw-r--r-- | doc/lua-filters.md | 14 | ||||
| -rw-r--r-- | tools/update-lua-docs.lua | 4 |
2 files changed, 9 insertions, 9 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md index 10dca0dce..dfd92a35b 100644 --- a/doc/lua-filters.md +++ b/doc/lua-filters.md @@ -1323,7 +1323,7 @@ Lua functions for pandoc scripts. See also: [OrderedList](#OrderedList) -## Helper Functions +## Helper functions [`pipe (command, args, input)`]{#pipe} @@ -1346,8 +1346,7 @@ Lua functions for pandoc scripts. [`walk_block (element, filter)`]{#walk_block} -: Apply a filter inside a block element, walking its - contents. +: Apply a filter inside a block element, walking its contents. Parameters: @@ -1355,8 +1354,8 @@ Lua functions for pandoc scripts. : the block element `filter`: - : a lua filter (table of functions) to be applied - within the block element + : a lua filter (table of functions) to be applied within + the block element Returns: the transformed block element @@ -1371,8 +1370,8 @@ Lua functions for pandoc scripts. : the inline element `filter`: - : a lua filter (table of functions) to be applied - within the inline element + : a lua filter (table of functions) to be applied within + the inline element Returns: the transformed inline element @@ -1399,7 +1398,6 @@ Lua functions for pandoc scripts. -- The inline element in that block is an `Emph` assert(block.content[1].t == "Emph") - # Module pandoc.utils This module exposes internal pandoc functions and utility diff --git a/tools/update-lua-docs.lua b/tools/update-lua-docs.lua index 7c5e86d17..746dce984 100644 --- a/tools/update-lua-docs.lua +++ b/tools/update-lua-docs.lua @@ -25,7 +25,9 @@ end function Header (el) if in_module_section then - if el.level == 1 then + if el.level == 1 or + -- special case for Module pandoc + (el.level == 2 and el.identifier == 'helper-functions') then in_module_section = false return el else |