Skip to content

Commit a254564

Browse files
author
Gabriel Monroy
committed
update client reference docs
1 parent 4f04098 commit a254564

21 files changed

Lines changed: 112 additions & 52 deletions

‎docs/client/apps.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:title: Applications
2+
:description: Learn how to manage Deis applications using the Deis client, including how to create, list, open, retrieve logs for, run ephemeral commands on, and destroy applications.
3+
4+
5+
apps
6+
====
7+
8+
.. automethod:: client.deis.DeisClient.apps_create
9+
.. automethod:: client.deis.DeisClient.apps_list
10+
.. automethod:: client.deis.DeisClient.apps_info
11+
.. automethod:: client.deis.DeisClient.apps_open
12+
.. automethod:: client.deis.DeisClient.apps_logs
13+
.. automethod:: client.deis.DeisClient.apps_run
14+
.. automethod:: client.deis.DeisClient.apps_destroy

‎docs/client/builds.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:title: Releases
2+
:description: Learn how to releases of an application using the Deis client.
3+
4+
5+
release
6+
=======
7+
8+
.. automethod:: client.deis.DeisClient.releases_list
9+
.. automethod:: client.deis.DeisClient.releases_info

‎docs/client/calculate.rst‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/client/config.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:title: Config
2+
:description: Learn how to list, set and unset environment variables for an application using the Deis client.
3+
4+
5+
config
6+
======
7+
8+
.. automethod:: client.deis.DeisClient.config_list
9+
.. automethod:: client.deis.DeisClient.config_set
10+
.. automethod:: client.deis.DeisClient.config_unset

‎docs/client/containers.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
:title: Containers
2-
:description: Learn how to scale and list Deis containers for a formation using the Deis client.
2+
:description: Learn how to list and scale Deis containers for an application using the Deis client.
33

44

55
containers
66
==========
77

8-
.. automethod:: client.deis.DeisClient.containers_scale
9-
:noindex:
108
.. automethod:: client.deis.DeisClient.containers_list
9+
.. automethod:: client.deis.DeisClient.containers_scale
1110

‎docs/client/converge.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎docs/client/create.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
:title: Create
2-
:description: Learn how to create a new Deis formation using the Deis client.
2+
:description: Learn how to create a new Deis application using the Deis client.
33

44

55
create
66
======
77

8-
.. automethod:: client.deis.DeisClient.formations_create
8+
.. automethod:: client.deis.DeisClient.apps_create
9+
:noindex:

‎docs/client/destroy.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
:title: Destroy
2-
:description: Learn how to destroy a Deis formation using the Deis client.
2+
:description: Learn how to destroy a Deis application using the Deis client.
33

44

55
destroy
66
=======
77

8-
.. automethod:: client.deis.DeisClient.formations_destroy
8+
.. automethod:: client.deis.DeisClient.apps_destroy
9+
:noindex:

‎docs/client/flavors.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:title: Flavors
2-
:description: Learn how to create, print information about and delete a node flavor, and list available node flavors using the Deis client. Deis flavors.
2+
:description: Learn how to create, print information about and delete a node flavor, and list available node flavors using the Deis client.
33

44

55
flavors

‎docs/client/formations.rst‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
:title: Formations
2-
:description: Learn how to create, force converge and destroy a Deis formation, list available formations and recalculate a formation's databag using the Deis client.
2+
:description: Learn how to manage Deis formations using the Deis client, including how to create, list, update, converge, calculate and destroy formations.
33

44

55
formations
66
==========
77

88
.. automethod:: client.deis.DeisClient.formations_create
9-
:noindex:
10-
.. automethod:: client.deis.DeisClient.formations_info
11-
:noindex:
129
.. automethod:: client.deis.DeisClient.formations_list
13-
.. automethod:: client.deis.DeisClient.formations_calculate
14-
:noindex:
10+
.. automethod:: client.deis.DeisClient.formations_update
11+
.. automethod:: client.deis.DeisClient.formations_info
1512
.. automethod:: client.deis.DeisClient.formations_converge
16-
:noindex:
17-
.. automethod:: client.deis.DeisClient.formations_destroy
18-
:noindex:
13+
.. automethod:: client.deis.DeisClient.formations_calculate
14+
.. automethod:: client.deis.DeisClient.formations_destroy

0 commit comments

Comments
 (0)