Browse code

Add list of Docker Remote API Client Libraries. Fixes #800.

Andy Rothfusz authored on 2013/06/11 07:17:27
Showing 3 changed files
... ...
@@ -46,12 +46,11 @@ clean:
46 46
 	-rm -rf $(BUILDDIR)/*
47 47
 
48 48
 docs:
49
-	#-rm -rf $(BUILDDIR)/*
50 49
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html
51 50
 	@echo
52 51
 	@echo "Build finished. The documentation pages are now in $(BUILDDIR)/html."
53 52
 
54
-server:
53
+server: docs
55 54
 	@cd $(BUILDDIR)/html; $(PYTHON) -m SimpleHTTPServer 8000
56 55
 
57 56
 site:
... ...
@@ -62,12 +61,13 @@ site:
62 62
 
63 63
 connect:
64 64
 	@echo connecting dotcloud to www.docker.io website, make sure to use user 1
65
-	@cd _build/website/ ; \
65
+	@echo or create your own "dockerwebsite" app
66
+	@cd $(BUILDDIR)/website/ ; \
66 67
 	dotcloud connect dockerwebsite ; \
67 68
 	dotcloud list
68 69
 
69 70
 push:
70
-	@cd _build/website/ ; \
71
+	@cd $(BUILDDIR)/website/ ; \
71 72
 	dotcloud push
72 73
 
73 74
 $(VERSIONS):
... ...
@@ -1056,3 +1056,27 @@ Here are the steps of 'docker run' :
1056 1056
 
1057 1057
 In this first version of the API, some of the endpoints, like /attach, /pull or /push uses hijacking to transport stdin,
1058 1058
 stdout and stderr on the same socket. This might change in the future.
1059
+
1060
+==================================
1061
+Docker Remote API Client Libraries
1062
+==================================
1063
+
1064
+These libraries have been not tested by the Docker Maintainers for
1065
+compatibility. Please file issues with the library owners.  If you
1066
+find more library implementations, please list them in Docker doc bugs
1067
+and we will add the libraries here.
1068
+
1069
++----------------------+----------------+--------------------------------------------+
1070
+| Language/Framework   | Name           | Repository                                 |
1071
++======================+================+============================================+
1072
+| Python               | docker-py      | https://github.com/dotcloud/docker-py      |
1073
++----------------------+----------------+--------------------------------------------+
1074
+| Ruby                 | docker-ruby    | https://github.com/ActiveState/docker-ruby |
1075
++----------------------+----------------+--------------------------------------------+
1076
+| Ruby                 | docker-client  | https://github.com/geku/docker-client      |
1077
++----------------------+----------------+--------------------------------------------+
1078
+| Javascript           | docker-js      | https://github.com/dgoujard/docker-js      |
1079
++----------------------+----------------+--------------------------------------------+
1080
+| Javascript (Angular) | dockerui       | https://github.com/crosbymichael/dockerui  |
1081
+| **WebUI**            |                |                                            |
1082
++----------------------+----------------+--------------------------------------------+
... ...
@@ -5,7 +5,7 @@
5 5
 APIs
6 6
 ====
7 7
 
8
-This following :
8
+Your programs and scripts can access Docker's functionality via these interfaces:
9 9
 
10 10
 .. toctree::
11 11
   :maxdepth: 3