sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-02-21 20:38:57 +00:00
Code Issues Releases Wiki Activity

doc/build_plugin_docs: Improve plugin formatting.

Browse Source 
Add a table of contents to the plugin list page along with page breaks
to divide things up.
This commit is contained in:
Marc Bonnici 2018-04-27 13:24:58 +01:00 committed by setrofim
parent a0dfac78c3
commit 2aeaedb8bc
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/build_plugin_docs.py
View File

@ -22,11 +22,23 @@ from wa import pluginloader
from wa.framework.configuration.core import RunConfiguration, MetaConfiguration from wa.framework.configuration.core import RunConfiguration, MetaConfiguration
from wa.framework.target.descriptor import list_target_descriptions from wa.framework.target.descriptor import list_target_descriptions
from wa.utils.doc import (strip_inlined_text, get_rst_from_plugin, from wa.utils.doc import (strip_inlined_text, get_rst_from_plugin,
get_params_rst, underline) get_params_rst, underline, line_break)
from wa.utils.misc import capitalize from wa.utils.misc import capitalize
GENERATE_FOR_PLUGIN = ['workload', 'instrument', 'output_processor'] GENERATE_FOR_PLUGIN = ['workload', 'instrument', 'output_processor']
def insert_contents_table(title='', depth=1):
"""
Insert a sphinx directive to insert a contents page with
a configurable title and depth.
"""
text = '''\n
.. contents:: {}
:depth: {}
:local:\n
'''.format(title, depth)
return text
def generate_plugin_documentation(source_dir, outdir, ignore_paths): def generate_plugin_documentation(source_dir, outdir, ignore_paths):
pluginloader.clear() pluginloader.clear()
@ -39,12 +51,16 @@ def generate_plugin_documentation(source_dir, outdir, ignore_paths):
continue continue
outfile = os.path.join(outdir, '{}s.rst'.format(ext_type)) outfile = os.path.join(outdir, '{}s.rst'.format(ext_type))
with open(outfile, 'w') as wfh: with open(outfile, 'w') as wfh:
wfh.write('.. _{}s:\n\n'.format(ext_type)) wfh.write('.. _{}s:\n\n'.format(ext_type.replace('_', '-')))
title = ' '.join([capitalize(w) for w in ext_type.split('_')]) title = ' '.join([capitalize(w) for w in ext_type.split('_')])
wfh.write(underline('{}s'.format(title))) wfh.write(underline('{}s'.format(title)))
wfh.write(insert_contents_table())
wfh.write(break_line())
exts = pluginloader.list_plugins(ext_type) exts = pluginloader.list_plugins(ext_type)
for ext in sorted(exts, key=lambda x: x.name): for ext in sorted(exts, key=lambda x: x.name):
wfh.write(get_rst_from_plugin(ext)) wfh.write(get_rst_from_plugin(ext))
wfh.write(break_line())
def generate_target_documentation(outdir): def generate_target_documentation(outdir):
targets_to_generate = ['generic_android', targets_to_generate = ['generic_android',
@ -80,6 +96,7 @@ def generate_target_documentation(outdir):
text += get_params_rst(td.assistant_params) text += get_params_rst(td.assistant_params)
wfh.write(text) wfh.write(text)
def generate_run_config_documentation(outdir): def generate_run_config_documentation(outdir):
generate_config_documentation(RunConfiguration, outdir) generate_config_documentation(RunConfiguration, outdir)