From bd5a19e6a7bddf694c7386040ae198a1581ef4d4 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Thu, 21 May 2020 15:16:14 +0200 Subject: Add specdoc.py --- specdoc.py | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100755 specdoc.py (limited to 'specdoc.py') diff --git a/specdoc.py b/specdoc.py new file mode 100755 index 00000000..a7d9133a --- /dev/null +++ b/specdoc.py @@ -0,0 +1,41 @@ +#!/usr/bin/env python +# SPDX-License-Identifier: BSD-2-Clause +""" Helps to document the specification. """ + +# Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +import rtemsqual.items +import rtemsqual.specdoc +import rtemsqual.util + + +def main() -> None: + """ Documents the specification. """ + config = rtemsqual.util.load_config("config.yml") + item_cache = rtemsqual.items.ItemCache(config["spec"]) + rtemsqual.specdoc.document(config["spec-documentation"], item_cache) + + +if __name__ == "__main__": + main() -- cgit v1.2.3