.. mayawalk documentation master file, created by
   sphinx-quickstart on Sun Jan 17 18:56:11 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

mayawalk
========

.. automodule:: mayawalk

`Github <https://github.com/tahv/mayawalk>`_

Content
-------

Nodes functions

.. autosummary::
    :nosignatures:

    mayawalk.parent
    mayawalk.children
    mayawalk.siblings
    mayawalk.hierarchy
    mayawalk.top_nodes
    mayawalk.connections
    mayawalk.connected

Plugs functions

.. autosummary::
    :nosignatures:

    mayawalk.plugs
    mayawalk.plug_parent
    mayawalk.plug_children
    mayawalk.plug_has_source
    mayawalk.plug_has_destinations
    mayawalk.plug_has_connections

Enums

.. autosummary::
    :nosignatures:

    mayawalk.ConnectionStatus

|
|

Nodes functions
---------------

.. autofunction:: mayawalk.parent

|

.. autofunction:: mayawalk.children

|

.. autofunction:: mayawalk.siblings

|

.. autofunction:: mayawalk.hierarchy

|

.. autofunction:: mayawalk.top_nodes

|

.. autofunction:: mayawalk.connections

|

.. autofunction:: mayawalk.connected

|
|

Plugs functions
---------------

.. autofunction:: mayawalk.plugs

|

.. autofunction:: mayawalk.plug_parent

|

.. autofunction:: mayawalk.plug_children

|

.. autofunction:: mayawalk.plug_has_source

|

.. autofunction:: mayawalk.plug_has_destinations

|

.. autofunction:: mayawalk.plug_has_connections

|
|

Enums
-----

.. autoclass:: mayawalk.ConnectionStatus
  :members:
  :undoc-members: