Fix doc generation errors and re-organize examples (#914)

Fix doc generation errors and re-organize examples
Co-authored-by: jan Iversen <[email protected]>

Author: dhoomakethu

doc/conf.py

@@ -26,12 +26,12 @@
 # examples = os.path.join(parent_dir, "examples")
 example_contrib = os.path.join(parent_dir, "examples/contrib")
 example_common = os.path.join(parent_dir, "examples/common")
-example_gui = os.path.join(parent_dir, "examples/gui")
+# example_gui = os.path.join(parent_dir, "examples/gui")
 
 sys.path.insert(0, os.path.abspath(os.pardir))
 sys.path.append(example_common)
 sys.path.append(example_contrib)
-sys.path.append(example_gui)
+# sys.path.append(example_gui)
 # sys.path.extend([examples, example_common, example_contrib, example_gui])
 # sys.path.insert(0, os.path.abspath("../"))
 

doc/source/example/asyncio_server.rst

@@ -0,0 +1,4 @@
+==================================================
+Asyncio Server Example
+==================================================
+.. literalinclude:: ../../../examples/common/asyncio_server.py

doc/source/example/modules.rst

@@ -8,6 +8,7 @@ Examples
 
    async_asyncio_client
    async_asyncio_serial_client
+   asyncio_server
    asynchronous_asyncio_modbus_tls_client
    callback_server
    changing_framers
@@ -20,6 +21,7 @@ Examples
    synchronous_client
    synchronous_client_ext
    synchronous_server
+   updating_server
 
    asynchronous_asyncio_serial_client
    bcd_payload

doc/source/example/updating_server.rst

@@ -0,0 +1,4 @@
+==================================================
+Updating Server Example
+==================================================
+.. literalinclude:: ../../../examples/common/updating_server.py

doc/source/library/pymodbus.constants.rst

@@ -0,0 +1,14 @@
+pymodbus\.constants package
+===========================
+
+.. automodule:: pymodbus.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
+
+Submodules
+----------
+
+
+

doc/source/library/pymodbus.rst

@@ -12,6 +12,7 @@ Subpackages
 .. toctree::
 
     pymodbus.client
+    pymodbus.constants
     pymodbus.datastore
     pymodbus.framer
     pymodbus.internal
@@ -38,15 +39,6 @@ pymodbus\.bit\_write\_message module
     :undoc-members:
     :show-inheritance:
 
-pymodbus\.constants module
---------------------------
-
-.. automodule:: pymodbus.constants
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
-
 pymodbus\.device module
 -----------------------
 

examples/common/tornado_twister/asyncio_server.pyX renamed to examples/common/asyncio_server.py

@@ -13,14 +13,14 @@
 # --------------------------------------------------------------------------- #
 from pymodbus.version import version
 
-# from pymodbus.server.sync import StartTcpServer #NOSONAR
-# from pymodbus.server.sync import StartTlsServer #NOSONAR
-# from pymodbus.server.sync import StartUdpServer #NOSONAR
-# from pymodbus.server.sync import StartSerialServer #NOSONAR
+from pymodbus.server.sync import StartTcpServer  # NOSONAR
+# from pymodbus.server.sync import StartTlsServer # NOSONAR
+# from pymodbus.server.sync import StartUdpServer # NOSONAR
+# from pymodbus.server.sync import StartSerialServer # NOSONAR
 from pymodbus.device import ModbusDeviceIdentification
 from pymodbus.datastore import ModbusSequentialDataBlock
 
-# from pymodbus.datastore import ModbusSparseDataBlock #NOSONAR
+# from pymodbus.datastore import ModbusSparseDataBlock  # NOSONAR
 from pymodbus.datastore import ModbusSlaveContext, ModbusServerContext
 
 # from pymodbus.transaction import ModbusRtuFramer, ModbusBinaryFramer #NOSONAR
@@ -100,14 +100,14 @@ def run_server():
         ir=ModbusSequentialDataBlock(0, [17] * 100),
     )
 
-    ModbusServerContext(slaves=store, single=True)
+    context = ModbusServerContext(slaves=store, single=True)
 
     # ----------------------------------------------------------------------- #
     # initialize the server information
     # ----------------------------------------------------------------------- #
     # If you don"t set this or any fields, they are defaulted to empty strings.
     # ----------------------------------------------------------------------- #
-    ModbusDeviceIdentification(
+    identity = ModbusDeviceIdentification(
         info_name={
             "VendorName": "Pymodbus",
             "ProductCode": "PM",
@@ -122,7 +122,7 @@ def run_server():
     # run the server you want
     # ----------------------------------------------------------------------- #
     # Tcp:
-    # StartTcpServer(context, identity=identity, address=("", 5020))
+    StartTcpServer(context, identity=identity, address=("", 5020))
     #
     # TCP with different framer
     # StartTcpServer(context, identity=identity,