added some missing documentation

emsec · Oct 13, 2021 · 1d8db96 · 1d8db96
1 parent c98ffcf
commit 1d8db96
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 16 deletions.
diff --git a/documentation/sphinx_doc/gate_library_manager.rst b/documentation/sphinx_doc/gate_library_manager.rst
@@ -1,5 +1,5 @@
 Gate Library Manager
 ==========================
 
-.. autoclass:: hal_py.GateLibraryManager
+.. automodule:: hal_py.GateLibraryManager
    :members:
diff --git a/documentation/sphinx_doc/gate_type_component.rst b/documentation/sphinx_doc/gate_type_component.rst
@@ -0,0 +1,26 @@
+Gate Type Component
+==========================
+
+.. autoclass:: hal_py.GateTypeComponent
+   :members:
+
+.. autoclass:: hal_py.LUTComponent
+   :members:
+
+.. autoclass:: hal_py.FFComponent
+   :members:
+
+.. autoclass:: hal_py.LatchComponent
+   :members:
+
+.. autoclass:: hal_py.RAMComponent
+   :members:
+
+.. autoclass:: hal_py.InitComponent
+   :members:
+
+.. autoclass:: hal_py.StateComponent
+   :members:
+
+.. autoclass:: hal_py.RAMPortComponent
+   :members:
diff --git a/documentation/sphinx_doc/gate_type_property.rst b/documentation/sphinx_doc/gate_type_property.rst
@@ -0,0 +1,5 @@
+Gate Type Property
+==========================
+
+.. autoclass:: hal_py.GateTypeProperty
+   :members:
diff --git a/documentation/sphinx_doc/hal_py.rst b/documentation/sphinx_doc/hal_py.rst
@@ -4,22 +4,26 @@ HAL Core Documentation
 .. toctree::
    :maxdepth: 1
 
-   core_utils
+   base_plugin_interface
    boolean_function
-   path
-   gate_type
-   gate_library
-   gate_library_manager
+   core_utils
    data_container
+   endpoint
    gate
-   net
-   module
+   gate_library
+   gate_library_manager
+   gate_type
+   gate_type_component
+   gate_type_property
    grouping
-   endpoint
-   netlist
-   netlist_utils
-   base_plugin_interface
    gui_plugin_interface
-   plugin_manager
+   module
+   net
+   netlist
    netlist_factory
+   netlist_utils
    netlist_writer_manager
+   path
+   pin_direction
+   pin_type
+   plugin_manager
diff --git a/documentation/sphinx_doc/pin_direction.rst b/documentation/sphinx_doc/pin_direction.rst
@@ -0,0 +1,5 @@
+Pin Direction
+==========================
+
+.. autoclass:: hal_py.PinDirection
+   :members:
diff --git a/documentation/sphinx_doc/pin_type.rst b/documentation/sphinx_doc/pin_type.rst
@@ -0,0 +1,5 @@
+Pin Type
+==========================
+
+.. autoclass:: hal_py.PinType
+   :members:
diff --git a/plugins/netlist_simulator/documentation/netlist_simulator.rst b/plugins/netlist_simulator/documentation/netlist_simulator.rst
@@ -12,9 +12,6 @@ Netlist Simulator
 
    .. automethod:: __init__
 
-.. autoclass:: netlist_simulator.SignalValue
-   :members:
-
 .. autoclass:: netlist_simulator.Event
    :members: