Documentation shows typehints correctly (#153)

-    Updated Sphinx from 1.3 to 6.1.
-    Set autodoc_typehints = 'description'
-    Fixed project to be compatible with Sphinx 6.1

Author: pylessard

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: doc/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: doc/requirements.txt

doc/requirements.txt

@@ -1,3 +1,3 @@
-sphinx_rtd_theme>=0.3.1
-sphinx==1.6.3
+sphinx_rtd_theme>=1.2
+sphinx==6.1.3
 

doc/source/_static/theme_overrides.css

@@ -5,4 +5,4 @@ dl.class dd dl.attribute,dl.data {
 
 div.wy-nav-content {
 	max-width:1200px ! important;
-}
+}

doc/source/conf.py

@@ -33,6 +33,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
+    "sphinxcontrib.jquery"
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -68,7 +69,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -107,19 +108,23 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
+primary_domain = 'py'
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'sphinx_rtd_theme'
 
+toc_object_entries = False
+
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'sticky_navigation': False,
-    'collapse_navigation': True
+    'sticky_navigation': True,
+    'collapse_navigation': True,
+    'navigation_depth': 3,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -216,6 +221,8 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'udsoncandoc'
 
+autodoc_typehints = 'description'
+
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
@@ -299,4 +306,4 @@
 
 
 def setup(app):
-    app.add_stylesheet('theme_overrides.css')
+    app.add_css_file('theme_overrides.css')

doc/source/index.rst

@@ -2,9 +2,8 @@ Python implementation of UDS standard (ISO-14229)
 =================================================
 
 .. toctree::
-   :maxdepth: 2
    :hidden:
-
+   
    Home <self>
    udsoncan/intro
    udsoncan/connection

doc/source/udsoncan/client.rst

@@ -1,5 +1,7 @@
 Client
 ======
+.. toctree::
+    :maxdepth: 3 
 
 .. _Client:
 

doc/source/udsoncan/exceptions.rst

@@ -1,5 +1,5 @@
 Exceptions
-===========
+==========
 
 This section explains the different exceptions used in the project.
 
@@ -27,13 +27,13 @@ UnexpectedResponseException
 .. _TimeoutException:
 
 TimeoutException
----------------------------
+----------------
 
 .. autoclass:: udsoncan.exceptions.TimeoutException
 
 .. _ConfigError:
 
 ConfigError
----------------------------
+-----------
 
 .. autoclass:: udsoncan.exceptions.ConfigError

doc/source/udsoncan/request_response.rst

@@ -24,7 +24,9 @@ Request
 
 .. autoclass:: udsoncan.Request
 .. automethod:: udsoncan.Request.get_payload
+    :noindex:
 .. automethod:: udsoncan.Request.from_payload
+    :noindex:
 
 .. _Response:
 
@@ -41,15 +43,19 @@ Response
    response2 = Response.from_payload(payload)
    print(response2) # <PositiveResponse: [ECUReset] - 2 data bytes at 0x7f9367e619b0>
 
+
 .. autoclass:: udsoncan.Response
+    :members: 
 .. automethod:: udsoncan.Response.get_payload
+    :noindex:
 .. automethod:: udsoncan.Response.from_payload
+    :noindex:
 
 Response Codes
 ##############
 
 .. autoclass:: udsoncan::Response.Code
-   :members: 
-   :undoc-members:
-   :member-order: bysource
-   :exclude-members: get_name, is_negative, is_supported_by_standard
+    :members: 
+    :undoc-members:
+    :member-order: bysource
+    :exclude-members: get_name, is_negative, is_supported_by_standard

doc/source/udsoncan/services.rst

@@ -30,7 +30,7 @@ Each service is represented by a class that extends the ``BaseService`` class. T
 .. _AccessTimingParameter:
 
 AccessTimingParameter (0x83)
---------------------------------------
+----------------------------
 
 .. automethod:: udsoncan.services.AccessTimingParameter.make_request
 .. automethod:: udsoncan.services.AccessTimingParameter.interpret_response

udsoncan/client.py

@@ -552,7 +552,7 @@ def clear_dtc(self, group: int = 0xFFFFFF, memory_selection: Optional[int] = Non
         :type group: int
 
         :param memory_selection: MemorySelection byte (0-0xFF). This value is user defined and introduced in 2020 version of ISO-14229-1. 
-        Only added to the request payload when different from None. Default : None
+            Only added to the request payload when different from None. Default : None
         :type memory_selection: int
 
         :return: The server response parsed by :meth:`ClearDiagnosticInformation.interpret_response<udsoncan.services.ClearDiagnosticInformation.interpret_response>`
@@ -1619,8 +1619,8 @@ def get_dtc_extended_data_by_record_number(self, record_number: int, data_size:
         :type record_number: int
 
         :param data_size: The number of bytes of each extended data record. If not specified ``config['extended_data_size']`` will be used. 
-        Since this method can return data for multiple DTCs and data size might be different for each DTC, it is possible to pass a dictionary 
-        with a size for each DTC id (just like ``extended_data_size`` configuration). Example : size = {0x123456 : 5, 0x112233 : 10}
+            Since this method can return data for multiple DTCs and data size might be different for each DTC, it is possible to pass a dictionary 
+            with a size for each DTC id (just like ``extended_data_size`` configuration). Example : size = {0x123456 : 5, 0x112233 : 10}
         :type data_size: int, dict or None
 
         :return: The server response parsed by :meth:`ReadDTCInformation.interpret_response<udsoncan.services.ReadDTCInformation.interpret_response>`