docs

docs/circuit.rst

@@ -0,0 +1,13 @@
+Circuit Graph - :mod:`kyupy.circuit`
+====================================
+
+.. automodule:: kyupy.circuit
+
+.. autoclass:: kyupy.circuit.Node
+   :members:
+
+.. autoclass:: kyupy.circuit.Line
+   :members:
+
+.. autoclass:: kyupy.circuit.Circuit
+   :members:

docs/datastructures.rst

@@ -1,29 +0,0 @@
-Data Structures
-===============
-
-KyuPy provides two types of core data structures, one for gate-level circuits, and a few others for representing and storing logic data and signal values.
-The data structures are designed to work together nicely with numpy arrays.
-For example, all the nodes and connections in the circuit graph have consecutive integer indices that can be used to access ndarrays with associated data.
-Circuit graphs also define an ordering of inputs, outputs and other nodes to easily process test vector data and alike.
-
-Circuit Graph - :mod:`kyupy.circuit`
-------------------------------------
-
-.. automodule:: kyupy.circuit
-
-.. autoclass:: kyupy.circuit.Node
-   :members:
-
-.. autoclass:: kyupy.circuit.Line
-   :members:
-
-.. autoclass:: kyupy.circuit.Circuit
-   :members:
-
-Multi-Valued Logic - :mod:`kyupy.logic`
----------------------------------------
-
-.. automodule:: kyupy.logic
-   :members:
-
-

docs/index.rst

@@ -4,9 +4,10 @@ API Reference
 -------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   datastructures
+   circuit
+   logic
    parsers
    simulators
    miscellaneous

docs/logic.rst

@@ -0,0 +1,7 @@
+Multi-Valued Logic - :mod:`kyupy.logic`
+=======================================
+
+.. automodule:: kyupy.logic
+   :members:
+
+

src/kyupy/circuit.py

@@ -1,8 +1,13 @@
-"""Data structures for representing non-hierarchical gate-level circuits.
+"""Core module for handling non-hierarchical gate-level circuits.
 
 The class :class:`Circuit` is a container of nodes connected by lines.
 A node is an instance of class :class:`Node`,
 and a line is an instance of class :class:`Line`.
+
+The data structures are designed to work together nicely with numpy arrays.
+For example, all the nodes and connections in the circuit graph have consecutive integer indices that can be used to access ndarrays with associated data.
+Circuit graphs also define an ordering of inputs, outputs and other nodes to easily process test vector data and alike.
+
 """
 
 from collections import deque, defaultdict

src/kyupy/logic.py

@@ -1,4 +1,4 @@
-"""This module contains definitions and tools for 2-, 4-, and 8-valued logic operations.
+"""Core module for handling 2-, 4-, and 8-valued logic data and signal values.
 
 Logic values are stored in numpy arrays with data type ``np.uint8``.
 There are no explicit data structures in KyuPy for holding patterns, pattern sets or vectors.