Docs: add api doc for new modules.

nodedge · Nov 11, 2020 · ff70ecb · ff70ecb
1 parent 5149a96
commit ff70ecb
Show file tree

Hide file tree

Showing 19 changed files with 164 additions and 3 deletions.
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.add_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.add_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.add\_block
+==========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.add_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.eq_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.eq_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.eq\_block
+=========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.eq_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.ge_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.ge_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.ge\_block
+=========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.ge_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.gt_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.gt_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.gt\_block
+=========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.gt_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.le_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.le_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.le\_block
+=========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.le_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.lt_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.lt_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.lt\_block
+=========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.lt_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.mod_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.mod_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.mod\_block
+==========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.mod_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.mul_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.mul_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.mul\_block
+==========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.mul_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.pow_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.pow_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.pow\_block
+==========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.pow_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.rst
@@ -0,0 +1,27 @@
+nodedge.blocks.autogen.operator package
+=======================================
+
+Submodules
+----------
+
+.. toctree::
+
+   nodedge.blocks.autogen.operator.add_block
+   nodedge.blocks.autogen.operator.eq_block
+   nodedge.blocks.autogen.operator.ge_block
+   nodedge.blocks.autogen.operator.gt_block
+   nodedge.blocks.autogen.operator.le_block
+   nodedge.blocks.autogen.operator.lt_block
+   nodedge.blocks.autogen.operator.mod_block
+   nodedge.blocks.autogen.operator.mul_block
+   nodedge.blocks.autogen.operator.pow_block
+   nodedge.blocks.autogen.operator.sub_block
+   nodedge.blocks.autogen.operator.truediv_block
+
+Module contents
+---------------
+
+.. automodule:: nodedge.blocks.autogen.operator
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.sub_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.sub_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.sub\_block
+==========================================
+
+.. automodule:: nodedge.blocks.autogen.operator.sub_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.operator.truediv_block.rst b/docs/source/apidoc/nodedge.blocks.autogen.operator.truediv_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.autogen.operator.truediv\_block
+==============================================
+
+.. automodule:: nodedge.blocks.autogen.operator.truediv_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.autogen.rst b/docs/source/apidoc/nodedge.blocks.autogen.rst
@@ -0,0 +1,17 @@
+nodedge.blocks.autogen package
+==============================
+
+Subpackages
+-----------
+
+.. toctree::
+
+   nodedge.blocks.autogen.operator
+
+Module contents
+---------------
+
+.. automodule:: nodedge.blocks.autogen
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.custom.input_block.rst b/docs/source/apidoc/nodedge.blocks.custom.input_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.custom.input\_block
+==================================
+
+.. automodule:: nodedge.blocks.custom.input_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.custom.output_block.rst b/docs/source/apidoc/nodedge.blocks.custom.output_block.rst
@@ -0,0 +1,7 @@
+nodedge.blocks.custom.output\_block
+===================================
+
+.. automodule:: nodedge.blocks.custom.output_block
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.custom.rst b/docs/source/apidoc/nodedge.blocks.custom.rst
@@ -0,0 +1,18 @@
+nodedge.blocks.custom package
+=============================
+
+Submodules
+----------
+
+.. toctree::
+
+   nodedge.blocks.custom.input_block
+   nodedge.blocks.custom.output_block
+
+Module contents
+---------------
+
+.. automodule:: nodedge.blocks.custom
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.blocks.rst b/docs/source/apidoc/nodedge.blocks.rst
@@ -1,6 +1,14 @@
 nodedge.blocks package
 ======================
 
+Subpackages
+-----------
+
+.. toctree::
+
+   nodedge.blocks.autogen
+   nodedge.blocks.custom
+
 Submodules
 ----------
 

diff --git a/...ource/apidoc/nodedge.node_list_widget.rst → ...ource/apidoc/nodedge.node_tree_widget.rst b/...ource/apidoc/nodedge.node_list_widget.rst → ...ource/apidoc/nodedge.node_tree_widget.rst
@@ -1,7 +1,7 @@
-nodedge.node\_list\_widget
+nodedge.node\_tree\_widget
 ==========================
 
-.. automodule:: nodedge.node_list_widget
+.. automodule:: nodedge.node_tree_widget
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/apidoc/nodedge.rst b/docs/source/apidoc/nodedge.rst
@@ -34,7 +34,7 @@ Submodules
    nodedge.mdi_widget
    nodedge.mdi_window
    nodedge.node
-   nodedge.node_list_widget
+   nodedge.node_tree_widget
    nodedge.scene
    nodedge.scene_clipboard
    nodedge.scene_coder