Skip to content

Commit

Permalink
Add automatically generated Engine API docs
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Firshman <[email protected]>
  • Loading branch information
bfirsh authored and Misty Stanley-Jones committed Jan 19, 2017
1 parent 2f3218c commit f8dac1b
Show file tree
Hide file tree
Showing 5 changed files with 243 additions and 19 deletions.
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/referen
&& wget -O allv/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \
&& rm -rf allv/apidocs/cloud-api-source \
&& rm -rf allv/tests \
&& wget -O allv/engine/api/v1.25/swagger.yaml https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/api/swagger.yaml \
&& jekyll build -s allv -d allvbuild \
&& find allvbuild/engine/reference -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
&& find allvbuild/engine/extend -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/#g' \
Expand Down
42 changes: 23 additions & 19 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -477,26 +477,30 @@ toc:
title: volume rm
- path: /engine/reference/commandline/wait/
title: wait
- sectiontitle: API Reference
- sectiontitle: Engine API
section:
- path: /engine/api/v1.25/
title: Reference
- path: /engine/api/client-libraries/
title: Client libraries
- sectiontitle: Version history
section:
- path: /engine/reference/api/docker_remote_api/
title: Engine API
- path: /engine/reference/api/docker_remote_api_v1.24/
title: Engine API v1.24
- path: /engine/reference/api/docker_remote_api_v1.23/
title: Engine API v1.23
- path: /engine/reference/api/docker_remote_api_v1.22/
title: Engine API v1.22
- path: /engine/reference/api/docker_remote_api_v1.21/
title: Engine API v1.21
- path: /engine/reference/api/docker_remote_api_v1.20/
title: Engine API v1.20
- path: /engine/reference/api/docker_remote_api_v1.19/
title: Engine API v1.19
- path: /engine/reference/api/docker_remote_api_v1.18/
title: Engine API v1.18
- path: /engine/reference/api/remote_api_client_libraries/
title: Engine API client libraries
- path: /engine/api/version-history/
title: Overview
- path: /engine/api/v1.24/
title: v1.24 reference
- path: /engine/api/v1.23/
title: v1.23 reference
- path: /engine/api/v1.22/
title: v1.22 reference
- path: /engine/api/v1.21/
title: v1.21 reference
- path: /engine/api/v1.20/
title: v1.20 reference
- path: /engine/api/v1.19/
title: v1.19 reference
- path: /engine/api/v1.18/
title: v1.18 reference
- path: /engine/migration/
title: Migrate to Engine 1.10
- path: /engine/breaking_changes/
Expand Down
131 changes: 131 additions & 0 deletions engine/api/client-libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
---
redirect_from:
- /engine/reference/api/remote_api_client_libraries/
- /reference/api/remote_api_client_libraries/
description: Various client libraries available to use with the Docker Engine API
keywords:
- API, Docker, index, registry, REST, documentation, clients, C#, Erlang, Go, Groovy, Java, JavaScript, Perl, PHP, Python, Ruby, Rust, Scala
title: Engine API client libraries
---

These libraries make it easier to build applications on top of the Docker
Engine with various programming languages. They have not been tested by the
Docker maintainers for compatibility, so if you run into any issues, file them
with the library maintainers.

<table border="1" class="docutils">
<colgroup>
<col width="29%">
<col width="23%">
<col width="48%">
</colgroup>
<thead valign="bottom">
<tr>
<th class="head">Language/Framework</th>
<th class="head">Name</th>
<th class="head">Repository</th>
</tr>
</thead>
<tbody valign = "top">
<tr>
<td>C#</td>
<td>Docker.DotNet</td>
<td><a class="reference external" href="https://github.com/ahmetalpbalkan/Docker.DotNet">https://github.com/ahmetalpbalkan/Docker.DotNet</a></td>
</tr>
<tr>
<td>C++</td>
<td>lasote/docker_client</td>
<td><a class="reference external" href="https://github.com/lasote/docker_client">https://github.com/lasote/docker_client</a></td>
</tr>
<tr>
<td>Erlang</td>
<td>erldocker</td>
<td><a class="reference external" href="https://github.com/proger/erldocker">https://github.com/proger/erldocker</a></td>
</tr>
<tr>
<td>Dart</td>
<td>bwu_docker</td>
<td><a class="reference external" href="https://github.com/bwu-dart/bwu_docker">https://github.com/bwu-dart/bwu_docker</a></td>
</tr>
<tr>
<td>Go</td>
<td>Docker Go client</td>
<td><a class="reference external" href="https://godoc.org/github.com/docker/docker/client">https://godoc.org/github.com/docker/docker/client</a></td>
</tr>
<tr>
<td>Gradle</td>
<td>gradle-docker-plugin</td>
<td><a class="reference external" href="https://github.com/gesellix/gradle-docker-plugin">https://github.com/gesellix/gradle-docker-plugin</a></td>
</tr>
<tr>
<td>Groovy</td>
<td>docker-client</td>
<td><a class="reference external" href="https://github.com/gesellix/docker-client">https://github.com/gesellix/docker-client</a></td>
</tr>
<tr>
<td>Haskell</td>
<td>docker-hs</td>
<td><a class="reference external" href="https://github.com/denibertovic/docker-hs">https://github.com/denibertovic/docker-hs</a></td>
</tr>
<tr>
<td>HTML (Web Components)</td>
<td>docker-elements</td>
<td><a class="reference external" href="https://github.com/kapalhq/docker-elements">https://github.com/kapalhq/docker-elements</a></td>
</tr>
<tr>
<td>Java</td>
<td>docker-java</td>
<td><a class="reference external" href="https://github.com/docker-java/docker-java">https://github.com/docker-java/docker-java</a></td>
</tr>
<tr>
<td>Java</td>
<td>docker-client</td>
<td><a class="reference external" href="https://github.com/spotify/docker-client">https://github.com/spotify/docker-client</a></td>
</tr>
<tr>
<td>NodeJS</td>
<td>dockerode</td>
<td><a class="reference external" href="https://github.com/apocas/dockerode">https://github.com/apocas/dockerode</a></td>
</tr>
<tr>
<td>Perl</td>
<td>Eixo::Docker</td>
<td><a class="reference external" href="https://github.com/alambike/eixo-docker">https://github.com/alambike/eixo-docker</a></td>
</tr>
<tr>
<td>PHP</td>
<td>Docker-PHP</td>
<td><a class="reference external" href="https://github.com/docker-php/docker-php">https://github.com/docker-php/docker-php</a></td>
</tr>
<tr>
<td>Python</td>
<td>docker-py</td>
<td><a class="reference external" href="https://github.com/docker/docker-py">https://github.com/docker/docker-py</a></td>
</tr>
<tr>
<td>Ruby</td>
<td>docker-api</td>
<td><a class="reference external" href="https://github.com/swipely/docker-api">https://github.com/swipely/docker-api</a></td>
</tr>
<tr>
<td>Rust</td>
<td>docker-rust</td>
<td><a class="reference external" href="https://github.com/abh1nav/docker-rust">https://github.com/abh1nav/docker-rust</a></td>
</tr>
<tr>
<td>Rust</td>
<td>shiplift</td>
<td><a class="reference external" href="https://github.com/softprops/shiplift">https://github.com/softprops/shiplift</a></td>
</tr>
<tr>
<td>Scala</td>
<td>tugboat</td>
<td><a class="reference external" href="https://github.com/softprops/tugboat">https://github.com/softprops/tugboat</a></td>
</tr>
<tr>
<td>Scala</td>
<td>reactive-docker</td>
<td><a class="reference external" href="https://github.com/almoehi/reactive-docker">https://github.com/almoehi/reactive-docker</a></td>
</tr>
</tbody>
</table>
41 changes: 41 additions & 0 deletions engine/api/v1.25/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
layout: null
redirect_from:
- /engine/api/
- /engine/reference/api/
- /engine/reference/api/docker_remote_api/
- /engine/reference/api/docker_remote_api_v1.25/
- /reference/api/
---
<!DOCTYPE html>
<html>
<head>
<title>Docker Engine API v1.25 Reference</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Reference for the API served by Docker Engine.">

<!--
ReDoc doesn't change outer page styles
-->
<style>
body {
margin: 0;
padding: 0;
}
api-logo {
background-image: linear-gradient(0deg, #15A4D7 0%, #1488C6 100%);
height: 100px;
text-align: left !important;
}
api-logo img {
width: 136px !important;
margin: 32px 0 0 50px;
}
</style>
</head>
<body>
<redoc spec-url="swagger.yaml" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
<script src="redoc.1.6.0.min.js"> </script>
</body>
</html>
47 changes: 47 additions & 0 deletions engine/api/v1.25/redoc.1.6.0.min.js

Large diffs are not rendered by default.

0 comments on commit f8dac1b

Please sign in to comment.