Cacher is the code snippet organizer for pro developers

Overview of Pynu (Python Node Utilities)
========================================

The library offers two helper classes, GraphNode and TreeNode. TreeNode can be
considered to be a special case of a GraphNode. A TreeNode may have only one
parent at a time. In addition it provides functionality to find the root of the
tree (find_root) and to walk through each node of the tree based on the node
used as a pivot.

Node
----

Both GraphNode and TreeNode have been derived from Node that provides following
functionality:

.. automethod:: pynu.node.Node.__setattr__

.. automethod:: pynu.node.NodeContainer.empty

.. automethod:: pynu.node.NodeContainer.append

.. automethod:: pynu.node.NodeContainer.remove

.. automethod:: pynu.node.NodeContainer.find

GraphNode
---------

Currently GraphNode does not provide any extra functionality.

TreeNode
--------

TreeNode provides following utility methods:

.. autoclass:: pynu.TreeNode
    :members:
    :inherited-members:

...

# Make sure that the Sphinx documentation builder (sphinx-build or make.bat) finds the source.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.append(os.path.abspath('../'))
import pynu

...

# Remember to enable autodoc!

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', ]

...

# It's easier to refer to __version__ at __init__.py so when you release a new
# version, there's just one place to update.

# The short X.Y version.
version = pynu.__version__
# The full version, including alpha/beta/rc tags.
release = pynu.__version__

...