Skip to content

Commit

Permalink
test build
Browse files Browse the repository at this point in the history
seems like I found a fix for graphviz issue
  • Loading branch information
mdabrowski1990 committed Oct 27, 2023
1 parent ef18f7d commit f313385
Show file tree
Hide file tree
Showing 8 changed files with 50 additions and 22 deletions.
9 changes: 3 additions & 6 deletions .readthedocs.yaml
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/source/pages/user_guide/transport.rst
Expand Up @@ -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 <https://python-can.readthedocs.io/en/master/#>`_ 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
Expand Down
37 changes: 34 additions & 3 deletions 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`
4 changes: 2 additions & 2 deletions 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.
4 changes: 2 additions & 2 deletions 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.
4 changes: 2 additions & 2 deletions 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.
4 changes: 2 additions & 2 deletions 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.
4 changes: 2 additions & 2 deletions 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.

0 comments on commit f313385

Please sign in to comment.