From f31338535a4280b0bdda3c9ca0b144d509be9460 Mon Sep 17 00:00:00 2001 From: Maciej Dabrowski Date: Fri, 27 Oct 2023 11:38:21 +0200 Subject: [PATCH] test build seems like I found a fix for graphviz issue --- .readthedocs.yaml | 9 ++--- docs/source/pages/user_guide/transport.rst | 6 +-- .../source/pages/user_guide/transport/can.rst | 37 +++++++++++++++++-- .../pages/user_guide/transport/custom.rst | 4 +- .../pages/user_guide/transport/ethernet.rst | 4 +- .../pages/user_guide/transport/flexray.rst | 4 +- .../pages/user_guide/transport/kline.rst | 4 +- .../source/pages/user_guide/transport/lin.rst | 4 +- 8 files changed, 50 insertions(+), 22 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 85a5a804..0ea46a0c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,14 +7,11 @@ build: os: ubuntu-22.04 tools: python: "3.11" - jobs: - pre_install: - - whoami - - sudo apg-get update - - sudo apg-get install graphviz + apt_packages: + - graphviz - # Build documentation in the docs/ directory with Sphinx +# Build documentation in the docs/ directory with Sphinx sphinx: builder: html fail_on_warning: true diff --git a/docs/source/pages/user_guide/transport.rst b/docs/source/pages/user_guide/transport.rst index 619b1886..71cf7c81 100644 --- a/docs/source/pages/user_guide/transport.rst +++ b/docs/source/pages/user_guide/transport.rst @@ -3,12 +3,12 @@ Transport Interfaces Transport interfaces are meant to handle Physical (layer 1), Data (layer 2), Network (layer 3) and Transport (layer 4) layers of UDS OSI model which are unique for every communication bus. First two layers (Physical and Data Link) are usually handled by external packages (e.g. `python-can `_ handles -first two layers for CAN bus). - +first two layers for CAN bus). Abstract API that is common for all Transport Interfaces (and therefore buses) +is defined in :class:`~uds.transport_interface.abstract_transport_interface.AbstractTransportInterface` class. .. toctree:: :maxdepth: 1 - :caption: Transport Interface Implementations: + :caption: Implementation of Transport Interface: transport/can.rst transport/ethernet.rst diff --git a/docs/source/pages/user_guide/transport/can.rst b/docs/source/pages/user_guide/transport/can.rst index be3836a2..44f38e10 100644 --- a/docs/source/pages/user_guide/transport/can.rst +++ b/docs/source/pages/user_guide/transport/can.rst @@ -1,3 +1,34 @@ -CAN Transport Interface -======================= -TODO: rework +CAN Transport Interfaces +======================== +TODO: some general info + +Common +------ +Common CAN implementation for all CAN :class:`~uds.transport_interface.can_transport_interface.AbstractCanTransportInterface` + +Configuration +````````````` +TODO: __init__ explanation + + +Python-CAN +---------- +TODO: :class:`~uds.transport_interface.can_transport_interface.PyCanTransportInterface` + +Configuration +````````````` +TODO: __init__ explanation (only diff) + +Send Packet +``````````` +TODO: +:meth:`~uds.transport_interface.can_transport_interface.PyCanTransportInterface.send_packet` +and +:meth:`~uds.transport_interface.can_transport_interface.PyCanTransportInterface.async_send_packet` + +Receive Packet +`````````````` +TODO: +:meth:`~uds.transport_interface.can_transport_interface.PyCanTransportInterface.receive_packet` +and +:meth:`~uds.transport_interface.can_transport_interface.PyCanTransportInterface.async_receive_packet` diff --git a/docs/source/pages/user_guide/transport/custom.rst b/docs/source/pages/user_guide/transport/custom.rst index 14aa0ebd..ad481d6f 100644 --- a/docs/source/pages/user_guide/transport/custom.rst +++ b/docs/source/pages/user_guide/transport/custom.rst @@ -1,3 +1,3 @@ -Custom Transport Interface -========================== +Custom Transport Interfaces +=========================== THIS FEATURE IS PLANNED BUT NOT IMPLEMENTED YET, THEREFORE THERE ARE NO MORE INFORMATION TO DISPLAY. \ No newline at end of file diff --git a/docs/source/pages/user_guide/transport/ethernet.rst b/docs/source/pages/user_guide/transport/ethernet.rst index 3fff44ee..79e9a7f5 100644 --- a/docs/source/pages/user_guide/transport/ethernet.rst +++ b/docs/source/pages/user_guide/transport/ethernet.rst @@ -1,3 +1,3 @@ -Ethernet Transport Interface -============================ +Ethernet Transport Interfaces +============================= Ethernet FEATURE IS PLANNED BUT NOT IMPLEMENTED YET, THEREFORE THERE ARE NO MORE INFORMATION TO DISPLAY. \ No newline at end of file diff --git a/docs/source/pages/user_guide/transport/flexray.rst b/docs/source/pages/user_guide/transport/flexray.rst index 6982b487..cae2022b 100644 --- a/docs/source/pages/user_guide/transport/flexray.rst +++ b/docs/source/pages/user_guide/transport/flexray.rst @@ -1,3 +1,3 @@ -FlexRay Transport Interface -=========================== +FlexRay Transport Interfaces +============================ FlexRay FEATURE IS PLANNED BUT NOT IMPLEMENTED YET, THEREFORE THERE ARE NO MORE INFORMATION TO DISPLAY. \ No newline at end of file diff --git a/docs/source/pages/user_guide/transport/kline.rst b/docs/source/pages/user_guide/transport/kline.rst index c8a9881b..c6d50adc 100644 --- a/docs/source/pages/user_guide/transport/kline.rst +++ b/docs/source/pages/user_guide/transport/kline.rst @@ -1,3 +1,3 @@ -K-Line Transport Interface -========================== +K-Line Transport Interfaces +=========================== K-Line FEATURE IS PLANNED BUT NOT IMPLEMENTED YET, THEREFORE THERE ARE NO MORE INFORMATION TO DISPLAY. \ No newline at end of file diff --git a/docs/source/pages/user_guide/transport/lin.rst b/docs/source/pages/user_guide/transport/lin.rst index af958e08..dbb6ef8c 100644 --- a/docs/source/pages/user_guide/transport/lin.rst +++ b/docs/source/pages/user_guide/transport/lin.rst @@ -1,3 +1,3 @@ -LIN Transport Interface -======================= +LIN Transport Interfaces +======================== LIN FEATURE IS PLANNED BUT NOT IMPLEMENTED YET, THEREFORE THERE ARE NO MORE INFORMATION TO DISPLAY. \ No newline at end of file