mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-01-31 10:11:17 +00:00
f194ef281b
As the Makefile is no longer responsible for calling the extension and instrumentation documentation ensure any previously generated documentation is deleted from the respective build file.
51 lines
1.7 KiB
Python
Executable File
51 lines
1.7 KiB
Python
Executable File
#!/usr/bin/env python
|
|
# Copyright 2014-2015 ARM Limited
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
|
|
import os
|
|
import sys
|
|
import shutil
|
|
|
|
from wlauto import ExtensionLoader
|
|
from wlauto.utils.doc import get_rst_from_extension, underline
|
|
from wlauto.utils.misc import capitalize
|
|
|
|
|
|
GENERATE_FOR = ['workload', 'instrument', 'result_processor', 'device']
|
|
|
|
|
|
def generate_extension_documentation(source_dir, outdir, ignore_paths):
|
|
loader = ExtensionLoader(keep_going=True)
|
|
loader.clear()
|
|
loader.update(paths=[source_dir], ignore_paths=ignore_paths)
|
|
if os.path.exists(outdir):
|
|
shutil.rmtree(outdir)
|
|
os.makedirs(outdir)
|
|
for ext_type in loader.extension_kinds:
|
|
if not ext_type in GENERATE_FOR:
|
|
continue
|
|
outfile = os.path.join(outdir, '{}s.rst'.format(ext_type))
|
|
with open(outfile, 'w') as wfh:
|
|
wfh.write('.. _{}s:\n\n'.format(ext_type))
|
|
wfh.write(underline(capitalize('{}s'.format(ext_type))))
|
|
exts = loader.list_extensions(ext_type)
|
|
for ext in sorted(exts, key=lambda x: x.name):
|
|
wfh.write(get_rst_from_extension(ext))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
generate_extension_documentation(sys.argv[2], sys.argv[1], sys.argv[3:])
|