From 0fc6a708ef1e9203cc615da45a908bffb550ec59 Mon Sep 17 00:00:00 2001 From: Simmo Saan Date: Sun, 18 Oct 2015 12:16:48 +0300 Subject: doc: add clickable anchors to hdata listing in plugin API reference --- doc/docgen.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/docgen.py b/doc/docgen.py index 629f2d339..e9f31eee8 100644 --- a/doc/docgen.py +++ b/doc/docgen.py @@ -630,13 +630,15 @@ def docgen_cmd_cb(data, buf, args): doc = AutogenDoc(directory, 'plugin_api', 'hdata') for plugin in sorted(hdata): for hdata_name in sorted(hdata[plugin]): + anchor = 'hdata_{0}'.format(hdata_name) _hda = hdata[plugin][hdata_name] desc = translate(_hda['description']) variables = _hda['vars'] variables_update = _hda['vars_update'] lists = _hda['lists'] - doc.write('* \'{0}\': {1}\n'.format(escape(hdata_name), - escape(desc))) + doc.write('* [[{0}]]<<{0},\'{1}\'>>: {2}\n' + ''.format(escape(anchor), escape(hdata_name), + escape(desc))) doc.write('** {0}: {1}\n'.format(_('plugin'), escape(plugin))) doc.write('** {0}:\n{1}'.format(_('variables'), -- cgit v1.2.3