Skip to content

Commit 94f4238

Browse files
Pierre-Luc Tessier Gagnéhardbyte
authored andcommitted
Documenting the plugin interface entry point
1 parent 878e043 commit 94f4238

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/interfaces.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@ The available interfaces are:
2424
interfaces/vector
2525
interfaces/virtual
2626

27+
Additional interfaces can be added via a plugin interface. An external package
28+
can register a new interface by using the `python_can.interface` entry point.
29+
30+
The format of the entry point is `interface_name=module:classname`.
31+
32+
::
33+
34+
entry_points={
35+
'python_can.interface': [
36+
"interface_name=module:classname",
37+
]
38+
},
2739

2840

2941
The *Interface Names* are listed in :doc:`configuration`.

0 commit comments

Comments
 (0)