38 lines
759 B
ReStructuredText
38 lines
759 B
ReStructuredText
|
.. pynodes documentation master file, created by
|
||
|
sphinx-quickstart on Sat Mar 30 18:38:12 2024.
|
||
|
You can adapt this file completely to your liking, but it should at least
|
||
|
contain the root `toctree` directive.
|
||
|
|
||
|
Welcome to pynodes's documentation!
|
||
|
===================================
|
||
|
|
||
|
**pynodes** is a Python library to manage Nodes classes.
|
||
|
A node is an object which is related to other nodes given a tree chart.
|
||
|
|
||
|
.. code-block:: console
|
||
|
|
||
|
(venv) $ pip install pynodes
|
||
|
|
||
|
.. toctree::
|
||
|
:maxdepth: 2
|
||
|
:caption: Contents:
|
||
|
|
||
|
Basic Usage
|
||
|
===========
|
||
|
.. code-block:: python
|
||
|
|
||
|
import pynodes
|
||
|
node = pynodes.Node()
|
||
|
|
||
|
.. autoclass:: pynodes.Node
|
||
|
:members:
|
||
|
|
||
|
|
||
|
|
||
|
Indices and tables
|
||
|
==================
|
||
|
|
||
|
* :ref:`genindex`
|
||
|
* :ref:`modindex`
|
||
|
* :ref:`search`
|