소스 검색

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

Andy Rothfusz 12 년 전
부모
커밋
eeea9ac946
3개의 변경된 파일29개의 추가작업 그리고 5개의 파일을 삭제
  1. 4 4
      docs/Makefile
  2. 24 0
      docs/sources/api/docker_remote_api.rst
  3. 1 1
      docs/sources/api/index.rst

+ 4 - 4
docs/Makefile

@@ -46,12 +46,11 @@ clean:
 	-rm -rf $(BUILDDIR)/*
 
 docs:
-	#-rm -rf $(BUILDDIR)/*
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The documentation pages are now in $(BUILDDIR)/html."
 
-server:
+server: docs
 	@cd $(BUILDDIR)/html; $(PYTHON) -m SimpleHTTPServer 8000
 
 site:
@@ -62,12 +61,13 @@ site:
 
 connect:
 	@echo connecting dotcloud to www.docker.io website, make sure to use user 1
-	@cd _build/website/ ; \
+	@echo or create your own "dockerwebsite" app
+	@cd $(BUILDDIR)/website/ ; \
 	dotcloud connect dockerwebsite ; \
 	dotcloud list
 
 push:
-	@cd _build/website/ ; \
+	@cd $(BUILDDIR)/website/ ; \
 	dotcloud push
 
 $(VERSIONS):

+ 24 - 0
docs/sources/api/docker_remote_api.rst

@@ -1056,3 +1056,27 @@ Here are the steps of 'docker run' :
 
 In this first version of the API, some of the endpoints, like /attach, /pull or /push uses hijacking to transport stdin,
 stdout and stderr on the same socket. This might change in the future.
+
+==================================
+Docker Remote API Client Libraries
+==================================
+
+These libraries have been not tested by the Docker Maintainers for
+compatibility. Please file issues with the library owners.  If you
+find more library implementations, please list them in Docker doc bugs
+and we will add the libraries here.
+
++----------------------+----------------+--------------------------------------------+
+| Language/Framework   | Name           | Repository                                 |
++======================+================+============================================+
+| Python               | docker-py      | https://github.com/dotcloud/docker-py      |
++----------------------+----------------+--------------------------------------------+
+| Ruby                 | docker-ruby    | https://github.com/ActiveState/docker-ruby |
++----------------------+----------------+--------------------------------------------+
+| Ruby                 | docker-client  | https://github.com/geku/docker-client      |
++----------------------+----------------+--------------------------------------------+
+| Javascript           | docker-js      | https://github.com/dgoujard/docker-js      |
++----------------------+----------------+--------------------------------------------+
+| Javascript (Angular) | dockerui       | https://github.com/crosbymichael/dockerui  |
+| **WebUI**            |                |                                            |
++----------------------+----------------+--------------------------------------------+

+ 1 - 1
docs/sources/api/index.rst

@@ -5,7 +5,7 @@
 APIs
 ====
 
-This following :
+Your programs and scripts can access Docker's functionality via these interfaces:
 
 .. toctree::
   :maxdepth: 3