Fix doc generation errors and re-organize examples

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/asynchronous_processor.rst

@@ -1,4 +1,4 @@
 ==================================================
 Asynchronous Processor Example
 ==================================================
-.. literalinclude:: ../../../examples/common/asynchronous_processor.py
+.. literalinclude:: ../../../examples/common/tornado_twisted/asynchronous_processor.py

doc/source/example/asynchronous_server.rst

@@ -1,4 +1,4 @@
 ===========================
 Asynchronous Server Example
 ===========================
-.. literalinclude:: ../../../examples/common/asynchronous_server.py
+.. literalinclude:: ../../../examples/common/tornado_twisted/asynchronous_server.py

doc/source/example/gui_common.rst

@@ -1,4 +1,4 @@
 ==================================================
 Modbus Scraper Example
 ==================================================
-.. literalinclude:: ../../../examples/contrib/modbus_scraper.py
+.. literalinclude:: ../../../examples/contrib/tornado_twisted/modbus_scraper.py

doc/source/example/modbus_scraper.rst

@@ -36,6 +36,6 @@ Examples
    modicon_payload
    remote_server_context
    serial_forwarder
-   sunspec_client
    thread_safe_datastore
-   gui_common
+   sunspec_client.rst
+

doc/source/example/modules.rst

@@ -1,4 +1,4 @@
 ==================================================
 Sunspec Client Example
 ==================================================
-.. literalinclude:: ../../../examples/contrib/sunspec_client.py
+.. literalinclude:: ../../../examples/contrib/tornado_twisted/sunspec_client.py

doc/source/example/sunspec_client.rst

@@ -1,7 +1,7 @@
 pymodbus\.client\.asynchronous\.asyncio package
 ===============================================
 
-.. automodule:: pymodbus.client.asynchronous.asyncio
+.. automodule:: pymodbus.client.asynchronous.async_io
     :members:
     :undoc-members:
     :show-inheritance:

…pymodbus.client.asynchronous.asyncio.rst …ymodbus.client.asynchronous.async_io.rstdoc/source/library/pymodbus.client.asynchronous.asyncio.rst renamed to doc/source/library/pymodbus.client.asynchronous.async_io.rst doc/source/library/pymodbus.client.asynchronous.asyncio.rst renamed to doc/source/library/pymodbus.client.asynchronous.async_io.rst

@@ -11,7 +11,7 @@ Subpackages
 
 .. toctree::
 
-    pymodbus.client.asynchronous.asyncio
+    pymodbus.client.asynchronous.async_io
     pymodbus.client.asynchronous.factory
     pymodbus.client.asynchronous.schedulers
 

doc/source/library/pymodbus.client.asynchronous.rst

@@ -1,7 +1,7 @@
-pymodbus\.internal package
+pymodbus\.constants package
 ==========================
 
-.. automodule:: pymodbus.internal
+.. automodule:: pymodbus.constants
     :members:
     :undoc-members:
     :show-inheritance: