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

doc/build_plugin_docs: Only load the required plugins

Browse Source 
When updating the pluginload only load the modules we want to document
rather than load all avalible and then filter.
This commit is contained in:
Marc Bonnici 2018-05-23 15:54:58 +01:00 committed by setrofim
parent 03e5c6c0af
commit bbb5cb9643
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/build_plugin_docs.py
View File

@ -25,7 +25,7 @@ from wa.utils.doc import (strip_inlined_text, get_rst_from_plugin,
get_params_rst, underline, line_break) 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_PACKAGES = ['wa.workloads', 'wa.instruments', 'wa.output_processors']
def insert_contents_table(title='', depth=1): def insert_contents_table(title='', depth=1):
""" """
@ -42,13 +42,11 @@ def insert_contents_table(title='', depth=1):
def generate_plugin_documentation(source_dir, outdir, ignore_paths): def generate_plugin_documentation(source_dir, outdir, ignore_paths):
pluginloader.clear() pluginloader.clear()
pluginloader.update(paths=[source_dir], ignore_paths=ignore_paths) pluginloader.update(packages=GENERATE_FOR_PACKAGES)
if not os.path.exists(outdir): if not os.path.exists(outdir):
os.mkdir(outdir) os.mkdir(outdir)
for ext_type in pluginloader.kinds: for ext_type in pluginloader.kinds:
if not ext_type in GENERATE_FOR_PLUGIN:
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.replace('_', '-'))) wfh.write('.. _{}s:\n\n'.format(ext_type.replace('_', '-')))