Skip to content

Commit b4c94c0

Browse files
committed
Plugins API documentation
Signed-off-by: Joffrey F <[email protected]>
1 parent b2aa220 commit b4c94c0

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed

docs/client.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Client reference
1919
.. autoattribute:: images
2020
.. autoattribute:: networks
2121
.. autoattribute:: nodes
22+
.. autoattribute:: plugins
2223
.. autoattribute:: services
2324
.. autoattribute:: swarm
2425
.. autoattribute:: volumes

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ That's just a taste of what you can do with the Docker SDK for Python. For more,
8484
images
8585
networks
8686
nodes
87+
plugins
8788
services
8889
swarm
8990
volumes

docs/plugins.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Plugins
2+
=======
3+
4+
.. py:module:: docker.models.plugins
5+
6+
Manage plugins on the server.
7+
8+
Methods available on ``client.plugins``:
9+
10+
.. rst-class:: hide-signature
11+
.. py:class:: PluginCollection
12+
13+
.. automethod:: get
14+
.. automethod:: install
15+
.. automethod:: list
16+
17+
18+
Plugin objects
19+
--------------
20+
21+
.. autoclass:: Plugin()
22+
23+
.. autoattribute:: id
24+
.. autoattribute:: short_id
25+
.. autoattribute:: name
26+
.. autoattribute:: enabled
27+
.. autoattribute:: settings
28+
.. py:attribute:: attrs
29+
30+
The raw representation of this object from the server.
31+
32+
.. automethod:: configure
33+
.. automethod:: disable
34+
.. automethod:: enable
35+
.. automethod:: reload
36+
.. automethod:: push
37+
.. automethod:: remove

0 commit comments

Comments
 (0)