Skip to content

Commit 1d8db96

Browse files
committed
added some missing documentation
1 parent c98ffcf commit 1d8db96

File tree

7 files changed

+58
-16
lines changed

7 files changed

+58
-16
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Gate Library Manager
22
==========================
33

4-
.. autoclass:: hal_py.GateLibraryManager
4+
.. automodule:: hal_py.GateLibraryManager
55
:members:
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Gate Type Component
2+
==========================
3+
4+
.. autoclass:: hal_py.GateTypeComponent
5+
:members:
6+
7+
.. autoclass:: hal_py.LUTComponent
8+
:members:
9+
10+
.. autoclass:: hal_py.FFComponent
11+
:members:
12+
13+
.. autoclass:: hal_py.LatchComponent
14+
:members:
15+
16+
.. autoclass:: hal_py.RAMComponent
17+
:members:
18+
19+
.. autoclass:: hal_py.InitComponent
20+
:members:
21+
22+
.. autoclass:: hal_py.StateComponent
23+
:members:
24+
25+
.. autoclass:: hal_py.RAMPortComponent
26+
:members:
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Gate Type Property
2+
==========================
3+
4+
.. autoclass:: hal_py.GateTypeProperty
5+
:members:

documentation/sphinx_doc/hal_py.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,26 @@ HAL Core Documentation
44
.. toctree::
55
:maxdepth: 1
66

7-
core_utils
7+
base_plugin_interface
88
boolean_function
9-
path
10-
gate_type
11-
gate_library
12-
gate_library_manager
9+
core_utils
1310
data_container
11+
endpoint
1412
gate
15-
net
16-
module
13+
gate_library
14+
gate_library_manager
15+
gate_type
16+
gate_type_component
17+
gate_type_property
1718
grouping
18-
endpoint
19-
netlist
20-
netlist_utils
21-
base_plugin_interface
2219
gui_plugin_interface
23-
plugin_manager
20+
module
21+
net
22+
netlist
2423
netlist_factory
24+
netlist_utils
2525
netlist_writer_manager
26+
path
27+
pin_direction
28+
pin_type
29+
plugin_manager
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Pin Direction
2+
==========================
3+
4+
.. autoclass:: hal_py.PinDirection
5+
:members:

documentation/sphinx_doc/pin_type.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Pin Type
2+
==========================
3+
4+
.. autoclass:: hal_py.PinType
5+
:members:

plugins/netlist_simulator/documentation/netlist_simulator.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ Netlist Simulator
1212

1313
.. automethod:: __init__
1414

15-
.. autoclass:: netlist_simulator.SignalValue
16-
:members:
17-
1815
.. autoclass:: netlist_simulator.Event
1916
:members:
2017

0 commit comments

Comments
 (0)