Updated documentation.

dockeroo · Aug 10, 2016 · e24a90b · e24a90b
1 parent 564293d
commit e24a90b
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -48,3 +48,35 @@ Status
 
 dockeroo is beta software.
 
+
+Recipes
+=======
+
+Docker recipes
+--------------
+
+* `dockeroo:docker.build <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.build>`_
+* `dockeroo:docker.copy <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.copy>`_
+* `dockeroo:docker.gentoo-bootstrap <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.gentoo_bootstrap>`_
+* `dockeroo:docker.gentoo-build <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.gentoo_build>`_
+* `dockeroo:docker.gentoo-diskimage <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.gentoo_diskimage>`_
+* `dockeroo:docker.network <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.network>`_
+* `dockeroo:docker.pull <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.pull>`_
+* `dockeroo:docker.push <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.push>`_
+* `dockeroo:docker.run <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.run>`_
+* `dockeroo:docker.volume <https://pythonhosted.org/dockeroo/docker.html#module-dockeroo.docker.volume>`_
+
+Docker Machine recipes
+----------------------
+
+* `dockeroo:machine.create <https://pythonhosted.org/dockeroo/docker_machine.html#module-dockeroo.machine.create>`_
+
+Setup recipes
+-------------
+
+* `dockeroo:setup.cmmi <https://pythonhosted.org/dockeroo/setup.html#module-dockeroo.setup.cmmi>`_
+* `dockeroo:setup.download <https://pythonhosted.org/dockeroo/setup.html#module-dockeroo.setup.download>`_
+* `dockeroo:setup.egg <https://pythonhosted.org/dockeroo/setup.html#module-dockeroo.setup.egg>`_
+* `dockeroo:setup.python-script <https://pythonhosted.org/dockeroo/setup.html#module-dockeroo.setup.python_script>`_
+* `dockeroo:setup.shell-script <https://pythonhosted.org/dockeroo/setup.html#module-dockeroo.setup.shell_script>`_
+* `dockeroo:setup.template <https://pythonhosted.org/dockeroo/setup.html#module-dockeroo.setup.template>`_
diff --git a/doc/docker_machine.rst b/doc/docker_machine.rst
@@ -4,4 +4,6 @@ Docker Machine recipes
 dockeroo:machine.create
 -----------------------
 
-.. autoclass:: dockeroo.docker_machine.create::DockerMachineCreateRecipe
+.. module:: dockeroo.docker_machine.create
+
+.. autoclass:: DockerMachineCreateRecipe
diff --git a/doc/setup.rst b/doc/setup.rst
@@ -4,29 +4,41 @@ Setup recipes
 dockeroo:setup.cmmi
 -------------------
 
-.. autoclass:: dockeroo.setup.cmmi::SetupCmmiRecipe
+.. module:: dockeroo.setup.cmmi
+
+.. autoclass:: SetupCmmiRecipe
 
 dockeroo:setup.download
 -----------------------
 
-.. autoclass:: dockeroo.setup.download::SetupDownloadRecipe
+.. module:: dockeroo.setup.download
+
+.. autoclass:: SetupDownloadRecipe
 
 dockeroo:setup.egg
 ------------------
 
-.. autoclass:: dockeroo.setup.egg::SetupEggRecipe
+.. module:: dockeroo.setup.egg
+
+.. autoclass:: SetupEggRecipe
 
 dockeroo:setup.python-script
 ----------------------------
 
-.. autoclass:: dockeroo.setup.python_script::SetupPythonScriptRecipe
+.. module:: dockeroo.setup.python_script
+
+.. autoclass:: SetupPythonScriptRecipe
 
 dockeroo:setup.shell-script
 ---------------------------
 
-.. autoclass:: dockeroo.setup.shell_script::SetupShellScriptRecipe
+.. module:: dockeroo.setup.shell_script
+
+.. autoclass:: SetupShellScriptRecipe
 
 dockeroo:setup.template
 -----------------------
 
-.. autoclass:: dockeroo.setup.template::SetupTemplateRecipe
+.. module:: dockeroo.setup.template
+
+.. autoclass:: SetupTemplateRecipe