source: rtems-central/spec2doc.py @ d3edaca

Last change on this file since d3edaca was e49c759, checked in by Sebastian Huber <sebastian.huber@…>, on Jul 15, 2020 at 8:04:25 AM

Rename "rtemsqual" in "rtemsspec"

  • Property mode set to 100755
File size: 2.0 KB
Line 
1#!/usr/bin/env python
2# SPDX-License-Identifier: BSD-2-Clause
3""" Generates files of the RTEMS documentation from the specification. """
4
5# Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
6#
7# Redistribution and use in source and binary forms, with or without
8# modification, are permitted provided that the following conditions
9# are met:
10# 1. Redistributions of source code must retain the above copyright
11#    notice, this list of conditions and the following disclaimer.
12# 2. Redistributions in binary form must reproduce the above copyright
13#    notice, this list of conditions and the following disclaimer in the
14#    documentation and/or other materials provided with the distribution.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26# POSSIBILITY OF SUCH DAMAGE.
27
28import rtemsspec
29
30
31def main() -> None:
32    """ Generates files of the RTEMS documentation from the specification. """
33    config = rtemsspec.util.load_config("config.yml")
34    item_cache = rtemsspec.items.ItemCache(config["spec"])
35    rtemsspec.applconfig.generate(config["appl-config"], item_cache)
36    rtemsspec.specdoc.document(config["spec-documentation"], item_cache)
37    rtemsspec.glossary.generate(config["glossary"], item_cache)
38    rtemsspec.interfacedoc.generate(config["interface-documentation"],
39                                    item_cache)
40
41
42if __name__ == "__main__":
43    main()
Note: See TracBrowser for help on using the repository browser.