diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-04 14:03:09 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-04 14:09:37 +0200 |
commit | 36b8c38d0a2eca480eb00e0057599cad75d53b9b (patch) | |
tree | 36b865f7bce5b5d93d586bf3669dbb2838111505 /spec2doc.py | |
parent | rtemsqual: Update package imports (diff) | |
download | rtems-central-36b8c38d0a2eca480eb00e0057599cad75d53b9b.tar.bz2 |
Rename specdoc.py in spec2doc.py
Generate all of the documentation files with it.
Diffstat (limited to 'spec2doc.py')
-rwxr-xr-x | spec2doc.py | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/spec2doc.py b/spec2doc.py new file mode 100755 index 00000000..18900a57 --- /dev/null +++ b/spec2doc.py @@ -0,0 +1,41 @@ +#!/usr/bin/env python +# SPDX-License-Identifier: BSD-2-Clause +""" Generates files of the RTEMS documentation from 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 + + +def main() -> None: + """ Generates files of the RTEMS documentation from the specification. """ + config = rtemsqual.util.load_config("config.yml") + item_cache = rtemsqual.items.ItemCache(config["spec"]) + rtemsqual.applconfig.generate(config["appl-config"], item_cache) + rtemsqual.specdoc.document(config["spec-documentation"], item_cache) + rtemsqual.glossary.generate(config["glossary"], item_cache) + + +if __name__ == "__main__": + main() |