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

.. py:module:: raesl.doc.sections


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


Functions
~~~~~~~~~

.. autoapisummary::

   raesl.doc.sections.node_decomp_level
   raesl.doc.sections.global_needs_and_designs
   raesl.doc.sections.get_node_table
   raesl.doc.sections.comp_node_goal_reqs
   raesl.doc.sections.comp_node_goal_cons
   raesl.doc.sections.comp_node_transformation_reqs
   raesl.doc.sections.comp_node_transformation_cons
   raesl.doc.sections.comp_node_behavior_reqs
   raesl.doc.sections.comp_node_behavior_cons
   raesl.doc.sections.comp_node_design_reqs
   raesl.doc.sections.global_design_reqs
   raesl.doc.sections.comp_node_design_cons
   raesl.doc.sections.global_design_cons
   raesl.doc.sections.comp_node_needs
   raesl.doc.sections.global_needs
   raesl.doc.sections.relation_node_table
   raesl.doc.sections.comp_node_relations
   raesl.doc.sections.comp_node_props
   raesl.doc.sections.comp_node_subcomps
   raesl.doc.sections.var_node_table
   raesl.doc.sections.get_var_table_row_elements



Attributes
~~~~~~~~~~

.. autoapisummary::

   raesl.doc.sections.LineGen
   raesl.doc.sections.TABLE_SINGLE
   raesl.doc.sections.TABLE_LEFT_DOUBLE


.. py:data:: LineGen

   

.. py:data:: TABLE_SINGLE
   :value: '+------------------------------------------------------------------------------------------------+'

   

.. py:data:: TABLE_LEFT_DOUBLE
   :value: '+:===============================================================================================+'

   

.. py:function:: node_decomp_level(depth: int, comps: List[ragraph.node.Node], h: int = 1, rich: str = None, rich_opts: dict = {})

   Yield a decomposition level intro section.


.. py:function:: global_needs_and_designs(h: int = 1)

   Yield a global need and design specification intro section.


.. py:function:: get_node_table(node: ragraph.node.Node, graph: Optional[ragraph.graph.Graph] = None, sub_nodes: Optional[List[str]] = None) -> List

   Returns a Markdown grid table.


.. py:function:: comp_node_goal_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a goal-requirement section for a component


.. py:function:: comp_node_goal_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a goal-constraint section for a component


.. py:function:: comp_node_transformation_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a transformation requirements section for a component.


.. py:function:: comp_node_transformation_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a transformation constraints section for a component.


.. py:function:: comp_node_behavior_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a behavior requirement section for a component node.


.. py:function:: comp_node_behavior_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a behavior constraint section for a component node.


.. py:function:: comp_node_design_reqs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a design requirements section for a component node.


.. py:function:: global_design_reqs(g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a global design requirements section.


.. py:function:: comp_node_design_cons(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a design constraint section for a component node.


.. py:function:: global_design_cons(g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a global design constraint section.


.. py:function:: comp_node_needs(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a need section for a component node.


.. py:function:: global_needs(g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a global need section.


.. py:function:: relation_node_table(r: ragraph.node.Node, g: ragraph.graph.Graph) -> List


.. py:function:: comp_node_relations(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int = 1) -> LineGen

   Yield a relation section for a component.


.. py:function:: comp_node_props(node: ragraph.node.Node, g: ragraph.graph.Graph, h: int) -> LineGen

   Yield a properties section for a component node


.. py:function:: comp_node_subcomps(node: ragraph.node.Node, h: int = 1)

   Yield a subcomponents sections for a component.


.. py:function:: var_node_table(g: ragraph.graph.Graph, h: int = 1, reference_list: bool = False) -> LineGen

   Yield a variable table section.


.. py:function:: get_var_table_row_elements(g: ragraph.graph.Graph, v: ragraph.node.Node) -> str

   Yield elements of a row in a var table.