:py:mod:`raesl.doc.utils`
=========================

.. py:module:: raesl.doc.utils

.. autoapi-nested-parse::

   Doc generation utility functions.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   raesl.doc.utils.get_component_goals
   raesl.doc.utils.get_component_transformations
   raesl.doc.utils.get_component_behaviors
   raesl.doc.utils.get_component_designs
   raesl.doc.utils.get_global_designs
   raesl.doc.utils.get_component_needs
   raesl.doc.utils.get_global_needs
   raesl.doc.utils.get_component_relations
   raesl.doc.utils.get_component_properties



.. py:function:: get_component_goals(component: ragraph.node.Node, graph: ragraph.graph.Graph, constraint: bool = True, inherited: bool = True) -> List[ragraph.node.Node]

   Get relevant goal requirements or constraints for a component.


.. py:function:: get_component_transformations(component: ragraph.node.Node, graph: ragraph.graph.Graph, constraint: bool = True) -> List[ragraph.node.Node]

   Get relevant transformation requirements or constraints for a component.


.. py:function:: get_component_behaviors(component: ragraph.node.Node, graph: ragraph.graph.Graph, constraint: bool = True) -> List[ragraph.node.Node]

   Get relevant behavior requirements or constraints for a component.


.. py:function:: get_component_designs(component: ragraph.node.Node, graph: ragraph.graph.Graph, constraint: bool = True) -> List[ragraph.node.Node]

   Get relevant design requirements or constraints for a component.


.. py:function:: get_global_designs(graph: ragraph.graph.Graph, constraint: bool = True) -> List[ragraph.node.Node]

   Get globally relevant design requirments or constraints.


.. py:function:: get_component_needs(component: ragraph.node.Node, graph: ragraph.graph.Graph) -> List[ragraph.node.Node]

   Get relevant needs for a component.


.. py:function:: get_global_needs(graph: ragraph.graph.Graph) -> List[ragraph.node.Node]

   Get globally relevant needs.


.. py:function:: get_component_relations(component: ragraph.node.Node, graph: ragraph.graph.Graph) -> List[ragraph.node.Node]

   Get relevant relations for a component.


.. py:function:: get_component_properties(component: ragraph.node.Node, graph: ragraph.graph.Graph) -> List[ragraph.node.Node]

   Get relevant properties for a component.