chrizog · Aug 31, 2025 · Aug 30, 2025
diff --git a/docs/api/client_service_instance.rst b/docs/api/client_service_instance.rst
@@ -0,0 +1,5 @@
+ClientServiceInstance
+=======================
+
+.. autoclass:: someipy::ClientServiceInstance
+    :exclude-members: __init__
diff --git a/docs/api/connect_to_someipy_daemon.rst b/docs/api/connect_to_someipy_daemon.rst
@@ -0,0 +1,4 @@
+connect_to_someipy_daemon
+===========================
+
+.. autofunction:: someipy::connect_to_someipy_daemon
diff --git a/docs/api/event.rst b/docs/api/event.rst
@@ -0,0 +1,5 @@
+Event
+===========================
+
+.. autoclass:: someipy::Event
+    :exclude-members: __init__
diff --git a/docs/api/eventgroup.rst b/docs/api/eventgroup.rst
@@ -0,0 +1,5 @@
+EventGroup
+=======================
+
+.. autoclass:: someipy::EventGroup
+    :exclude-members: __init__
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,32 @@
+API Reference
+=======================
+
+Classes
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   service
+   service_builder
+   method
+   method_result
+   eventgroup
+   event
+   server_service_instance
+   client_service_instance
+   serialization
+   transport_layer_protocol
+   message_type
+   return_code
+
+
+
+Functions
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   connect_to_someipy_daemon
+   someipy_logging
diff --git a/docs/api/message_type.rst b/docs/api/message_type.rst
@@ -0,0 +1,5 @@
+MessageType
+==========================
+
+.. autoclass:: someipy::MessageType
+    :exclude-members: __init__
diff --git a/docs/api/method.rst b/docs/api/method.rst
@@ -0,0 +1,5 @@
+Method
+===============
+
+.. autoclass:: someipy::Method
+    :exclude-members: __init__
diff --git a/docs/api/method_result.rst b/docs/api/method_result.rst
@@ -0,0 +1,5 @@
+MethodResult
+==========================
+
+.. autoclass:: someipy::MethodResult
+    :exclude-members: __init__
diff --git a/docs/api/return_code.rst b/docs/api/return_code.rst
@@ -0,0 +1,5 @@
+ReturnCode
+==========================
+
+.. autoclass:: someipy::ReturnCode
+    :exclude-members: __init__
diff --git a/docs/api/serialization.rst b/docs/api/serialization.rst
@@ -0,0 +1,6 @@
+Serialization
+=================
+
+.. automodule:: someipy.serialization
+   :members:
+   :show-inheritance:
diff --git a/docs/api/server_service_instance.rst b/docs/api/server_service_instance.rst
@@ -0,0 +1,5 @@
+ServerServiceInstance
+=======================
+
+.. autoclass:: someipy::ServerServiceInstance
+    :exclude-members: __init__
diff --git a/docs/api/service.rst b/docs/api/service.rst
@@ -0,0 +1,5 @@
+Service
+=======================
+
+.. autoclass:: someipy::Service
+    :exclude-members: __init__
diff --git a/docs/api/service_builder.rst b/docs/api/service_builder.rst
@@ -0,0 +1,5 @@
+ServiceBuilder
+=======================
+
+.. autoclass:: someipy::ServiceBuilder
+    :exclude-members: __init__
diff --git a/docs/api/someipy_logging.rst b/docs/api/someipy_logging.rst
@@ -0,0 +1,4 @@
+someipy_logging
+=======================
+
+.. automodule:: someipy.someipy_logging
diff --git a/docs/api/transport_layer_protocol.rst b/docs/api/transport_layer_protocol.rst
@@ -0,0 +1,5 @@
+TransportLayerProtocol
+===========================
+
+.. autoclass:: someipy::TransportLayerProtocol
+    :exclude-members: __init__
diff --git a/docs/calling_methods.rst b/docs/calling_methods.rst
@@ -36,7 +36,7 @@ In this example, we will call a SOME/IP method that calculates the sum of two si
 Details on defining data types can be found :doc:`here <service_interface>`.
 
 Step 2: Connect to the someipy Daemon
-----------------------------------
+--------------------------------------
 
 The first step is to connect to the someipy daemon. The daemon is a separate process communicating with the application using someipy via a Unix Domain Socket (UDS). The daemon is responsible for handling all communication with the SOME/IP network, including service discovery and message sending/receiving.
 
@@ -125,7 +125,7 @@ To avoid the ``RuntimeError`` it is possible to test whether the service was alr
             print(f"Error during method call: {e}")
 
 Step 6: Shutdown the Application
-----------------------------
+--------------------------------
 
 At the end of your application, make sure to stop offering the service instance and disconnect from the someipy daemon to ensure a clean shutdown of the application.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -6,15 +6,36 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+import sys
+from pathlib import Path
+
 project = "someipy"
 copyright = "2025, Christian H."
 author = "Christian H."
 release = "1.0.0"
 
+sys.path.insert(0, str(Path("..", "src").resolve()))
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+
+# Autodoc settings
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "private-members": False,
+}
+
+autodoc_typehints = "description"  # Show type hints in description
 
 templates_path = ["_templates"]
 exclude_patterns = []

diff --git a/docs/cookbook.rst b/docs/cookbook.rst
@@ -0,0 +1,10 @@
+Cookbook
+==========================
+
+.. toctree::
+    :maxdepth: 2
+
+    calling_methods
+    offering_methods
+    subscribing_events
+    offering_events
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -1,10 +1,10 @@
 Getting Started
-===============
+=================
 
-This guide demonstrates how to create a SOME/IP service using someipy that broadcasts temperature measurements every second. The complete example is available in the `example applications on GitHub <https://github.com/chrizog/someipy/blob/v2.0.0/example_apps/send_events_udp.py>`_.
+This guide demonstrates how to create a SOME/IP service using someipy that broadcasts temperature measurements every second using SOME/IP events. The complete example is available in the `example applications on GitHub <https://github.com/chrizog/someipy/blob/v2.0.0/example_apps/send_events_udp.py>`_.
 
 Prerequisites
-------------
+----------------
 
 - Linux (Ubuntu 22.04 or equivalent)
 - Python 3.8+
@@ -19,12 +19,12 @@ Install someipy from PyPI:
 
    pip3 install someipy
 
-Service Datatype Definition
+Service Data Type Definition
 ---------------------------
 
 Define the temperature data structure using Python dataclasses. No IDL files required.
 
-Create **temperature_msg.py**:
+Create ``temperature_msg.py``:
 
 .. code-block:: python
 
@@ -64,7 +64,7 @@ someipy is an `asyncio <https://docs.python.org/3/library/asyncio.html>`_ based
 
 First we will set up our application's structure. Typically in an asyncio application, a main coroutine-function is added which is executed using `asyncio.run <https://docs.python.org/3/library/asyncio-runner.html#id1>`_. Our application's logic will be added inside the main coroutine-function *async def main*.
 
-Create **send_events_udp.py** with the following structure:
+Create ``send_events_udp.py`` with the following structure:
 
 .. code-block:: python
 
@@ -265,4 +265,4 @@ Run the application using Python 3:
 
 .. code-block:: bash
 
-   python3 send_events_udp.py
+   python3 send_events_udp.py
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
 someipy - An Open-Source Python library for SOME/IP
-====================================
+=====================================================
 
 This is the documentation for someipy, an open-source Python library implementing the SOME/IP protocol, including SOME/IP Service Discovery. It is designed for fast prototyping of applications making SOME/IP more accessible to developers.
 
@@ -30,15 +30,13 @@ Table of Contents
 =================
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 2
 
     whatsnew
     getting_started
+    cookbook
     someipy_daemon
-    calling_methods
-    offering_events
-    offering_methods
-    subscribing_events
     service_discovery
     service_interface
     changelog
+    api/index
diff --git a/docs/offering_events.rst b/docs/offering_events.rst
@@ -72,7 +72,7 @@ The constructor of the ``ServerServiceInstance`` class requires several paramete
 - endpoint_ip: The IP address of the network interface on which the service is offered (127.0.0.1 in this example)
 - endpoint_port: The port on which the service is offered (3000 in this example)
 - ttl: The time-to-live for the service discovery entries (5 seconds in this example)
-- cyclic_offer_delay_ms: The period of the cylic offer service SD messages (2000 ms in this example)
+- cyclic_offer_delay_ms: The period of the cyclic offer service SD messages (2000 ms in this example)
 
 .. code-block:: python
 
@@ -115,11 +115,11 @@ Now that the service is offered, clients can subscribe to the eventgroup with ID
 Typical sending strategies for SOME/IP events are **cyclic updates** or **update on change**. Update on change means that an event is sent whenever the contained value changes. In a cyclic update, the event would be sent even if the contained data has not changed since the last publish.
 
 Step 6: Shutdown the Application
-----------------------------
+------------------------------------------------
 
 At the end of your application, make sure to stop offering the service instance and disconnect from the someipy daemon to ensure a clean shutdown of the application.
 
 .. code-block:: python
 
    await service_instance_temperature.stop_offer()
-   await someipy_daemon.disconnect_from_daemon()
+   await someipy_daemon.disconnect_from_daemon()
diff --git a/docs/offering_methods.rst b/docs/offering_methods.rst
@@ -129,7 +129,7 @@ The constructor of the ``ServerServiceInstance`` class requires several paramete
 - endpoint_ip: The IP address of the network interface on which the service is offered (127.0.0.1 in this example)
 - endpoint_port: The port on which the service is offered (3000 in this example)
 - ttl: The time-to-live for the service discovery entries (5 seconds in this example)
-- cyclic_offer_delay_ms: The period of the cylic offer service SD messages (2000 ms in this example)
+- cyclic_offer_delay_ms: The period of the cyclic offer service SD messages (2000 ms in this example)
 
 .. code-block:: python
 
@@ -155,11 +155,11 @@ Step 6: Announce the Service via Service Discovery
    await service_instance_addition.start_offer()
 
 Step 7: Shutdown the Application
-----------------------------
+---------------------------------
 
 At the end of your application, make sure to stop offering the service instance and disconnect from the someipy daemon to ensure a clean shutdown of the application.
 
 .. code-block:: python
 
    await service_instance_temperature.stop_offer()
-   await someipy_daemon.disconnect_from_daemon()
+   await someipy_daemon.disconnect_from_daemon()