Configuration

To include the configuration options, add the .. dox_trace_config:: directive to your documentation, e.g.:

.. _dox_trace_config:

Configuration
=============

Settings
--------

.. dox_trace_config::

Preview
-------

Different specification types without any explicit value set:

.. requirement:: Input_ConfigPreview_Requirement
    :category: input
    :ignore_in_export:

.. information:: Input_ConfigPreview_Information
    :category: input
    :ignore_in_export:

.. requirement:: SRS_ConfigPreview_Requirement
    :category: software
    :ignore_in_export:

.. information:: SRS_ConfigPreview_Information
    :category: software
    :ignore_in_export:

.. srs:: SRS_ConfigPreview_Srs
    :ignore_in_export:

.. spec:: SWA_ConfigPreview_Spec
    :ignore_in_export:

.. mod:: SWA_ConfigPreview_Mod
    :ignore_in_export:

.. interface:: SWA_ConfigPreview_Interface
    :ignore_in_export:

.. unit:: SMD_ConfigPreview_Unit
    :ignore_in_export:

.. interface:: SMD_ConfigPreview_Interface
    :ignore_in_export:

Type, ID and the content are always shown. With .. dox_trace_config::, it is possible to change the visibility of the other attributes as follows:

  • Show all

  • Hide empty

  • Hide empty and “[missing]”

  • Hide all

For this documentation the configuration can be found in the appendix.

Note, the setting is stored globally for each project (based on the project value in conf.py) in the browser-storage. Due to security reasons the browser-storage is bound to protocol://host:port, this means a local build and a documentation on a server can have a different setting.