Merge lp:~tvansteenburgh/charm-helpers/doc-updates into lp:charm-helpers

[Tim Van Steenburgh]

Update docs to match recent branches:

- Removed references to jujugui
- Added core.services docs

[Charles Butler (lazypower)]

+1 LGTM

[Charles Butler (lazypower)]

review: Approve

=== modified file 'charmhelpers/core/services/base.py'
--- charmhelpers/core/services/base.py	2014-08-05 13:02:58 +0000
+++ charmhelpers/core/services/base.py	2014-08-05 21:31:00 +0000
@@ -26,7 +26,7 @@
         setup tasks, in the most declarative way possible.
 
         Service definitions are dicts in the following formats (all keys except
-        'service' are optional):
+        'service' are optional)::
 
             {
                 "service": <service name>,
@@ -79,7 +79,7 @@
 
         The following registers an Upstart service called bingod that depends on
         a mongodb relation and which runs a custom `db_migrate` function prior to
-        restarting the service, and a Runit service called spadesd.
+        restarting the service, and a Runit service called spadesd::
 
             manager = services.ServiceManager([
                 {

=== modified file 'charmhelpers/core/services/helpers.py'
--- charmhelpers/core/services/helpers.py	2014-08-05 13:02:58 +0000
+++ charmhelpers/core/services/helpers.py	2014-08-05 21:31:00 +0000
@@ -73,7 +73,7 @@
         If you only care about a single unit on the relation, you can just
         access it as `{{ interface[0]['key'] }}`.  However, if you can at all
         support multiple units on a relation, you should iterate over the list,
-        like:
+        like::
 
             {% for unit in interface -%}
                 {{ unit['key'] }}{% if not loop.last %},{% endif %}

=== removed file 'docs/api/charmhelpers.contrib.jujugui.rst'
--- docs/api/charmhelpers.contrib.jujugui.rst	2014-06-09 14:56:35 +0000
+++ docs/api/charmhelpers.contrib.jujugui.rst	1970-01-01 00:00:00 +0000
@@ -1,16 +0,0 @@
-charmhelpers.contrib.jujugui package
-====================================
-
-charmhelpers.contrib.jujugui.utils module
------------------------------------------
-
-.. automodule:: charmhelpers.contrib.jujugui.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-.. automodule:: charmhelpers.contrib.jujugui
-    :members:
-    :undoc-members:
-    :show-inheritance:

=== modified file 'docs/api/charmhelpers.contrib.rst'
--- docs/api/charmhelpers.contrib.rst	2014-06-09 14:56:35 +0000
+++ docs/api/charmhelpers.contrib.rst	2014-08-05 21:31:00 +0000
@@ -7,7 +7,6 @@
     charmhelpers.contrib.charmhelpers
     charmhelpers.contrib.charmsupport
     charmhelpers.contrib.hahelpers
-    charmhelpers.contrib.jujugui
     charmhelpers.contrib.network
     charmhelpers.contrib.openstack
     charmhelpers.contrib.peerstorage

=== modified file 'docs/api/charmhelpers.core.rst'
--- docs/api/charmhelpers.core.rst	2014-06-09 14:56:35 +0000
+++ docs/api/charmhelpers.core.rst	2014-08-05 21:31:00 +0000
@@ -25,6 +25,20 @@
     :undoc-members:
     :show-inheritance:
 
+charmhelpers.core.services package
+----------------------------------
+
+.. automodule:: charmhelpers.core.services.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :special-members: __init__
+
+.. automodule:: charmhelpers.core.services.helpers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 .. automodule:: charmhelpers.core
     :members:

=== modified file 'setup.py'
--- setup.py	2014-06-09 15:23:32 +0000
+++ setup.py	2014-08-05 21:31:00 +0000
@@ -26,7 +26,6 @@
         "charmhelpers.contrib.charmsupport",
         "charmhelpers.contrib.saltstack",
         "charmhelpers.contrib.hahelpers",
-        "charmhelpers.contrib.jujugui",
         "charmhelpers.contrib.templating",
     ],
     'scripts': [