aboutsummaryrefslogtreecommitdiff
path: root/doc/markdowndoc.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2014-06-30 13:06:25 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2014-06-30 13:06:25 -0400
commit03b0b8932ea1c41854a487f9fa6555def9b59462 (patch)
tree491743468203ee0b49729d323a1f224aaf4ef669 /doc/markdowndoc.lua
parentb8a5a15f6171cbedc9007e5b05757aa4b72ff742 (diff)
downloadtextadept-03b0b8932ea1c41854a487f9fa6555def9b59462.tar.gz
textadept-03b0b8932ea1c41854a487f9fa6555def9b59462.zip
Condensed manual and API documentation into single files.
Diffstat (limited to 'doc/markdowndoc.lua')
-rw-r--r--doc/markdowndoc.lua199
1 files changed, 77 insertions, 122 deletions
diff --git a/doc/markdowndoc.lua b/doc/markdowndoc.lua
index dbc15864..1a8d5c5d 100644
--- a/doc/markdowndoc.lua
+++ b/doc/markdowndoc.lua
@@ -10,27 +10,26 @@ local table_concat = table.concat
-- @usage luadoc -d [output_path] -doclet path/to/markdowndoc [file(s)]
local M = {}
-local NAVFILE = '%s* [%s](%s)\n'
+local NAVFILE = '1. [%s](%s)\n'
+local MODULE = '<a id="%s"></a>\n# The `%s` Module\n\n'
local FIELD = '<a id="%s"></a>\n### `%s` %s\n\n'
local FUNCTION = '<a id="%s"></a>\n### `%s`(*%s*)\n\n'
local FUNCTION_NO_PARAMS = '<a id="%s"></a>\n### `%s`()\n\n'
---local FUNCTION = '### `%s` (%s)\n\n'
local DESCRIPTION = '%s\n\n'
local LIST_TITLE = '%s:\n\n'
local PARAM = '* *`%s`*: %s\n'
local USAGE = '* `%s`\n'
local RETURN = '* %s\n'
-local SEE = '* [`%s`](%s)\n'
+local SEE = '* [`%s`](#%s)\n'
local TABLE = '<a id="%s"></a>\n### `%s`\n\n'
---local TABLE = '### `%s`\n\n'
-local TFIELD = '* `%s`: %s\n '
+local TFIELD = '* `%s`: %s\n'
local HTML = [[
<!doctype html>
<html>
<head>
<title>%(title)</title>
- <link rel="stylesheet" href="../style.css" type="text/css" />
- <link rel="icon" href="../icon.png" type="image/png" />
+ <link rel="stylesheet" href="style.css" type="text/css" />
+ <link rel="icon" href="icon.png" type="image/png" />
<meta charset="utf-8" />
</head>
<body>
@@ -38,15 +37,11 @@ local HTML = [[
<div id="header">
%(header)
</div>
- <div id="nav">
- <h2>Modules</h2>
- %(nav)
- </div>
- <div id="toc">
- <h2>Contents</h2>
- %(toc)
- </div>
<div id="main">
+ <h1>Textadept API Documentation</h1>
+ <p><strong>Modules</strong></p>
+ %(toc)
+ <hr />
%(main)
</div>
<div id="footer">
@@ -61,29 +56,24 @@ local titles = {
[SEE] = 'See also', [TFIELD] = 'Fields'
}
--- Writes LuaDoc hierarchical module navigation to the given file.
--- @param f The navigation file being written to.
--- @param list The module list.
--- @param parent String parent module with a trailing '.' for sub-modules in
--- order to generate full page links.
-local function write_nav(f, list, parent)
- if not parent then parent = '' end
- local level = 0
- for _ in parent:gmatch('%.') do level = level + 1 end
- for _, name in ipairs(list) do
- f:write(string_format(NAVFILE, string_rep(' ', level * 4), name,
- parent..name..'.html'))
- if list[name] then
- f:write('\n')
- write_nav(f, list[name], parent..name..'.')
- end
- end
-end
-
-- Writes a LuaDoc description to the given file.
-- @param f The markdown file being written to.
-- @param description The description.
-local function write_description(f, description)
+-- @param name The name of the module the description belongs to. Used for
+-- headers in module descriptions.
+local function write_description(f, description, name)
+ if name then
+ -- Add anchors for module description headers.
+ description = description:gsub('\n(#+%s+([^\n]+))', function(header, text)
+ return string_format("\n\n<a id=\"%s.%s\"></a>\n\n%s", name,
+ text:gsub(' ', '.'), header)
+ end)
+ end
+ -- Substitute custom [`code`]() link convention with [`code`](#code) links.
+ local self_link = '(%[`([^`(]+)%(?%)?`%])%(%)'
+ description = description:gsub(self_link, function(link, id)
+ return string_format("%s(#%s)", link, id:gsub(':', '.'))
+ end)
f:write(string_format(DESCRIPTION, description))
end
@@ -91,30 +81,22 @@ end
-- @param f The markdown file being written to.
-- @param fmt The format of a list item.
-- @param list The LuaDoc list.
-local function write_list(f, fmt, list)
+-- @param name The name of the module the list belongs to. Used for @see.
+local function write_list(f, fmt, list, name)
if not list or #list == 0 then return end
if type(list) == 'string' then list = {list} end
f:write(string_format(LIST_TITLE, titles[fmt]))
for _, value in ipairs(list) do
- if fmt ~= SEE then
- f:write(string_format(fmt, value, value))
- else
- -- Parse the identifier to determine if it belongs to the current module.
- if value:find('%.') then
- -- The identifier belongs to a different module. Link to it.
- -- TODO: cannot link to fields, functions, or tables in `_G`.
- value = value:gsub('^_G%.', '')
- local link = value..'.html'
- local module, func = value:match('^(.+)%.([^.]+)$')
- if module and func then
- link = module..'.html'..(func ~= '' and '#'..func or '')
- end
- f:write(string_format(fmt, value, link))
+ if fmt == SEE and name ~= '_G' then
+ if not value:find('%.') then
+ -- Prepend module name to identifier if necessary.
+ value = name..'.'..value
else
- -- The identifier belongs to the same module. Anchor it.
- f:write(string_format(fmt, value, '#'..value))
+ -- TODO: cannot link to fields, functions, or tables in `_G`?
+ value = value:gsub('^_G%.', '')
end
end
+ f:write(string_format(fmt, value, value))
end
f:write('\n')
end
@@ -135,13 +117,10 @@ end
-- Called by LuaDoc to process a doc object.
-- @param doc The LuaDoc doc object.
function M.start(doc)
- local template = {
- title = 'Textadept API', header = '', toc = '', main = '', footer = ''
- }
+ local template = {title = '', header = '', toc = '', main = '', footer = ''}
local modules, files = doc.modules, doc.files
-- Create the header and footer, if given a template.
- local header, footer = '', ''
if M.options.template_dir ~= 'luadoc/doclet/html/' then
local p = io.popen('markdown "'..M.options.template_dir..'.header.md"')
template.header = p:read('*a')
@@ -151,39 +130,17 @@ function M.start(doc)
p:close()
end
- -- Create the navigation list.
- local hierarchy = {}
+ -- Create the table of contents.
+ local tocfile = M.options.output_dir..'/.api_toc.md'
+ local f = io_open(tocfile, 'wb')
for _, name in ipairs(modules) do
- local parent, self = name:match('^(.-)%.?([^.]+)$')
- local h = hierarchy
- for table in parent:gmatch('[^.]+') do
- if not h[table] then h[table] = {} end
- h = h[table]
- end
- h[#h + 1] = self
+ f:write(string_format(NAVFILE, name, '#'..name))
end
- require('lfs').mkdir(M.options.output_dir..'/api')
- local navfile = M.options.output_dir..'/api/.nav.md'
- local f = io_open(navfile, 'wb')
- write_nav(f, hierarchy)
f:close()
- local p = io_popen('markdown "'..navfile..'"')
- local nav = p:read('*a')
+ local p = io_popen('markdown "'..tocfile..'"')
+ local toc = p:read('*a')
p:close()
- os.remove(navfile)
-
- -- Write index.html.
- template.nav = nav
- local api_index = M.options.output_dir..'/.api_index.md'
- if require('lfs').attributes(api_index) then
- local p = io_popen('markdown -f toc -T "'..api_index..'"')
- template.toc, template.main = p:read('*a'):match('^(.-\n</ul>\n)(.+)$')
- p:close()
- end
- f = io_open(M.options.output_dir..'/api/index.html', 'wb')
- local html = HTML:gsub('%%%(([^)]+)%)', template)
- f:write(html)
- f:close()
+ os.remove(tocfile)
-- Create a map of doc objects to file names so their Markdown doc comments
-- can be extracted.
@@ -191,30 +148,32 @@ function M.start(doc)
for _, name in ipairs(files) do filedocs[files[name].doc] = name end
-- Loop over modules, creating Markdown documents.
+ local mdfile = M.options.output_dir..'/api.md'
+ local f = io_open(mdfile, 'wb')
for _, name in ipairs(modules) do
local module = modules[name]
local filename = filedocs[module.doc]
- local mdfile = M.options.output_dir..'/api/'..name..'.md'
- local f = io_open(mdfile, 'wb')
-
-- Write the header and description.
- f:write('# ', name, '\n\n')
- f:write(module.description, '\n\n')
+ f:write(string_format(MODULE, name, name))
f:write('- - -\n\n')
+ write_description(f, module.description, name)
-- Write fields.
if module.doc[1].class == 'module' then
local fields = module.doc[1].field
if fields and #fields > 0 then
table.sort(fields)
- f:write('## Fields\n\n')
- f:write('- - -\n\n')
+ f:write('## Fields defined by `', name, '`\n\n')
for _, field in ipairs(fields) do
local type, description = fields[field]:match('^(%b())%s*(.+)$')
+ if not field:find('%.') and name ~= '_G' then
+ field = name..'.'..field -- absolute name
+ else
+ field = field:gsub('^_G%.', '') -- strip _G required for Luadoc
+ end
f:write(string_format(FIELD, field, field, type or ''))
write_description(f, description or fields[field])
- f:write('- - -\n\n')
end
f:write('\n')
end
@@ -223,11 +182,13 @@ function M.start(doc)
-- Write functions.
local funcs = module.functions
if #funcs > 0 then
- f:write('## Functions\n\n')
- f:write('- - -\n\n')
+ f:write('## Functions defined by `', name, '`\n\n')
for _, fname in ipairs(funcs) do
local func = funcs[fname]
local params = table_concat(func.param, ', '):gsub('_', '\\_')
+ if not func.name:find('[%.:]') and name ~= '_G' then
+ func.name = name..'.'..func.name -- absolute name
+ end
if params ~= '' then
f:write(string_format(FUNCTION, func.name, func.name, params))
else
@@ -237,8 +198,7 @@ function M.start(doc)
write_hashmap(f, PARAM, func.param)
write_list(f, USAGE, func.usage)
write_list(f, RETURN, func.ret)
- write_list(f, SEE, func.see)
- f:write('- - -\n\n')
+ write_list(f, SEE, func.see, name)
end
f:write('\n')
end
@@ -246,40 +206,35 @@ function M.start(doc)
-- Write tables.
local tables = module.tables
if #tables > 0 then
- f:write('## Tables\n\n')
- f:write('- - -\n\n')
+ f:write('## Tables defined by `', name, '`\n\n')
for _, tname in ipairs(tables) do
local tbl = tables[tname]
+ if not tbl.name:find('%.') and
+ (name ~= '_G' or tbl.name == 'buffer' or tbl.name == 'view') then
+ tbl.name = name..'.'..tbl.name -- absolute name
+ elseif tbl.name ~= '_G.keys' and tbl.name ~= '_G.snippets' then
+ tbl.name = tbl.name:gsub('^_G%.', '') -- strip _G required for Luadoc
+ end
f:write(string_format(TABLE, tbl.name, tbl.name))
write_description(f, tbl.description)
write_hashmap(f, TFIELD, tbl.field)
write_list(f, USAGE, tbl.usage)
- write_list(f, SEE, tbl.see)
- f:write('- - -\n\n')
+ write_list(f, SEE, tbl.see, name)
end
end
-
- f:close()
-
- -- Write HTML.
- template.title = name..' - Textadept API'
- template.nav = nav:gsub('<a[^>]+>('..name:match('[^%.]+$')..')</a>', '%1')
- local p = io_popen('markdown -f toc -T "'..mdfile..'"')
- template.toc, template.main = p:read('*a'):match('^(.-\n</ul>\n)(.+)$')
- p:close()
- template.toc = template.toc:gsub('(<a.-)%b()(</a>)', '%1%2') -- strip params
- :gsub('<code>([^<]+)</code>', '%1') -- sans serif
- :gsub('>CASEINSEN[%w_]+', '><small%0</small>')
- :gsub('>FOLDFLAG_[%w_]+', '><small%0</small>')
- :gsub('>WRAPVISUAL[%w_]+', '><small%0</small>')
- :gsub('>rectangular_[%w_]+', '><small%0</small>')
- :gsub('>_G.(events.[%w_]+)',
- '><small>%1</small>')
- f = io_open(M.options.output_dir..'/api/'..name..'.html', 'wb')
- local html = HTML:gsub('%%%(([^)]+)%)', template)
- f:write(html)
- f:close()
+ f:write('- - -\n\n')
end
+
+ -- Write HTML.
+ template.title = 'Textadept API'
+ template.toc = toc
+ local p = io_popen('markdown "'..mdfile..'"')
+ template.main = p:read('*a')
+ p:close()
+ f = io_open(M.options.output_dir..'/api.html', 'wb')
+ local html = HTML:gsub('%%%(([^)]+)%)', template)
+ f:write(html)
+ f:close()
end
return M
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-09 16:43:39 +0000