diff options
| -rw-r--r-- | config.yml | 3 | ||||
| -rwxr-xr-x | specdoc.py | 41 |
2 files changed, 44 insertions, 0 deletions
@@ -88,3 +88,6 @@ interface: rtems: external/rtems spec-verification: root-type: /spec/root +spec-documentation: + root-type: /spec/root + doc-target: external/rtems-docs/eng/req/items.rst 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() |