Skip to content

Commit c3ff5a0

Browse files
author
Richard Clubb
committed
added more documentation
1 parent 9e02fb4 commit c3ff5a0

File tree

6 files changed

+20
-2
lines changed

6 files changed

+20
-2
lines changed

docs/can.rst

Whitespace-only changes.

docs/canTp.rst

Whitespace-only changes.

docs/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ from the Bootloader.odx file.
1616
Currently it supports diagnostics on CAN using a CAN Transport Protocol defined in ISo-15765
1717
and uses the python-can package to utilise the can device interface.
1818

19+
The `final report <https://github.com/richClubb/python-uds/blob/master/docs/final%20report/Python%20UDS%20Manager%20-%20Final%20Report.pdf>`_ is available in the repository.
20+
1921
.. toctree::
2022
:maxdepth: 2
2123
:caption: Contents:
@@ -24,4 +26,3 @@ and uses the python-can package to utilise the can device interface.
2426
configuration
2527
interface
2628

27-

docs/interface.rst

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
Interface
22
---------
33

4+
.. toctree::
5+
:maxdepth: 2
6+
:caption: Contents:
7+
8+
uds
9+
tpFactory
10+
canTp
11+
can
12+
13+
Keyword Arguments
14+
-----------------
415
These keywords can be used to configure the other object instances
516

617
Uds
@@ -35,4 +46,5 @@ Vector
3546

3647
Virtual
3748

38-
- interfaceName (DEFAULT: )(Currently STATIC)
49+
- interfaceName (DEFAULT: )(Currently STATIC)
50+

docs/tpFactory.rst

Whitespace-only changes.

docs/uds.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Uds Interface
2+
-------------
3+
4+
.. automodule:: uds.Uds
5+
:members:

0 commit comments

Comments
 (0)