Merge pull request #1094 from pouchrobot/auto-doc-2018-04-11

docs: auto generate pouch cli/api docs via code

Author: allencloud

CONTRIBUTORS

@@ -14,6 +14,7 @@ chenzhimin <[email protected]>
 Cindy <[email protected]>
 CodeJuan <[email protected]>
 codejuan <[email protected]>
+dbdd4us <[email protected]>
 Dewey-Ding <[email protected]>
 Frank Yang <[email protected]>
 frankyang <[email protected]>

docs/api/HTTP_API.md

@@ -783,6 +783,43 @@ POST /daemon/update
 * `application/json`
 
 
+<a name="execinspect"></a>
+### Inspect an exec instance
+```
+GET /exec/{id}/json
+```
+
+
+#### Description
+Return low-level information about an exec instance.
+
+
+#### Parameters
+
+|Type|Name|Description|Schema|
+|---|---|---|---|
+|**Path**|**id**  <br>*required*|Exec instance ID|string|
+
+
+#### Responses
+
+|HTTP Code|Description|Schema|
+|---|---|---|
+|**200**|No error|[ContainerExecInspect](#containerexecinspect)|
+|**404**|No such exec instance|[4ErrorResponse](#4errorresponse)|
+|**500**|Server error|[0ErrorResponse](#0errorresponse)|
+
+
+#### Produces
+
+* `application/json`
+
+
+#### Tags
+
+* Exec
+
+
 <a name="execstart"></a>
 ### Start an exec instance
 ```
@@ -1546,6 +1583,25 @@ response returned by daemon when container create successfully
 |**Warnings**  <br>*required*|Warnings encountered when creating the container|< string > array|
 
 
+<a name="containerexecinspect"></a>
+### ContainerExecInspect
+holds information about a running process started.
+
+
+|Name|Description|Schema|
+|---|---|---|
+|**CanRemove**  <br>*optional*||boolean|
+|**ContainerID**  <br>*optional*|The ID of this container|string|
+|**DetachKeys**  <br>*optional*||string|
+|**ExitCode**  <br>*optional*|The last exit code of this container|integer|
+|**ID**  <br>*optional*|The ID of this exec|string|
+|**OpenStderr**  <br>*optional*||boolean|
+|**OpenStdin**  <br>*optional*||boolean|
+|**OpenStdout**  <br>*optional*||boolean|
+|**ProcessConfig**  <br>*optional*||[ProcessConfig](#processconfig)|
+|**Running**  <br>*optional*||boolean|
+
+
 <a name="containerjson"></a>
 ### ContainerJSON
 ContainerJSON contains response of Engine API:
@@ -1734,6 +1790,8 @@ Configuration for a network endpoint.
 
 <a name="execcreateconfig"></a>
 ### ExecCreateConfig
+is a small subset of the Config struct that holds the configuration.
+
 
 |Name|Description|Schema|
 |---|---|---|
@@ -1750,14 +1808,18 @@ Configuration for a network endpoint.
 
 <a name="execcreateresp"></a>
 ### ExecCreateResp
+contains response of Remote API POST "/containers/{name:.*}/exec".
 
-|Name|Schema|
-|---|---|
-|**Id**  <br>*optional*|string|
+
+|Name|Description|Schema|
+|---|---|---|
+|**Id**  <br>*optional*|ID is the exec ID|string|
 
 
 <a name="execstartconfig"></a>
 ### ExecStartConfig
+ExecStartConfig is a temp struct used by execStart.
+
 
 |Name|Description|Schema|
 |---|---|---|
@@ -2109,6 +2171,20 @@ entries are added to the mapping table.
 *Type* : < string, < [PortBinding](#portbinding) > array > map
 
 
+<a name="processconfig"></a>
+### ProcessConfig
+ExecProcessConfig holds information about the exec process.
+
+
+|Name|Schema|
+|---|---|
+|**arguments**  <br>*optional*|< string > array|
+|**entrypoint**  <br>*optional*|string|
+|**privileged**  <br>*optional*|boolean|
+|**tty**  <br>*optional*|boolean|
+|**user**  <br>*optional*|string|
+
+
 <a name="registryserviceconfig"></a>
 ### RegistryServiceConfig
 RegistryServiceConfig stores daemon registry services configuration.

docs/commandline/pouch_network.md

@@ -6,6 +6,10 @@ Manage pouch networks
 
 Manager the networks in pouchd. It contains the functions of create/remove/list/inspect network, 'driver' is used to list drivers that pouch support. Now bridge network is supported in pouchd defaulted, it will be initialized when pouchd starting.
 
+```
+pouch network [command]
+```
+
 ### Options
 
 ```

docs/commandline/pouch_volume.md

@@ -6,6 +6,10 @@ Manage pouch volumes
 
 Manager the volumes in pouchd. It contains the functions of create/remove/list/inspect volume, 'driver' is used to list drivers that pouch support. The default volume driver is local, it will make a directory to bind into container.
 
+```
+pouch volume [command]
+```
+
 ### Options
 
 ```