#1959 Added SoftLayer-Python architectural diagrams, fixed documentation build errors

Author: allmightyspiff

SoftLayer/CLI/search.py

@@ -30,6 +30,7 @@ def cli(env, query, types, advanced):
 
     Read More: https://sldn.softlayer.com/reference/services/SoftLayer_Search/search/
     Examples:
+
         slcli search test.com
         slcli search _objectType:SoftLayer_Virtual_Guest test.com
         slcli -vvv search _objectType:SoftLayer_Hardware hostname:testibm --advanced

SoftLayer/managers/search.py

@@ -1,14 +1,14 @@
 """
     SoftLayer.search
-    ~~~~~~~~~~~~~~~~~~
+    ~~~~~~~~~~~~~~~~
     Search Manager
 
     :license: MIT, see LICENSE for more details.
 """
 
 
 class SearchManager(object):
-    """Manager to help searcha via the SoftLayer API.
+    """Manager to help search via the SoftLayer API.
 
     :param SoftLayer.API.BaseClient client: the client instance
     """
@@ -18,27 +18,21 @@ def __init__(self, client):
         self.search_manager = client['SoftLayer_Search']
 
     def get_object_types(self):
-        """returns a collection of SoftLayer_Container_Search_ObjectType containers.
-
-        """
+        """returns a collection of SoftLayer_Container_Search_ObjectType containers."""
         return self.search_manager.getObjectTypes()
 
     def search(self, search_string):
-        """allows for searching for SoftLayer resources by simple phrase.
-
-        """
+        """allows for searching for SoftLayer resources by simple phrase."""
         return self.search_manager.search(search_string)
 
     def advanced(self, search_string):
-        """allows for searching for SoftLayer resources by simple phrase.
-
-        """
+        """Uses the SoftLayer_Search::advancedSearch API. Allows for more complicated search phrases."""
         return self.search_manager.advancedSearch(search_string)
 
     def search_instances(self, search_string, mask=None, **kwargs):
         """Lists VSIs based in the search_string.
 
-        Also takes in a few search terms as **kwargs. such as hostname, datacenter, domain and tags
+        Also takes in a few search terms as \*\*kwargs. such as hostname, datacenter, domain and tags
         """
 
         # This forces the Search API to do a fuzzy search on our term, kinda. Not sure why the ** are
@@ -65,8 +59,8 @@ def search_instances(self, search_string, mask=None, **kwargs):
     def search_hadrware_instances(self, search_string, mask=None, **kwargs):
         """Lists hardwares based in the search_string.
 
-                Also takes in a few search terms as **kwargs. such as hostname, datacenter, domain and tags
-                """
+        Also takes in a few search terms as \*\*kwargs. such as hostname, datacenter, domain and tags
+        """
 
         # This forces the Search API to do a fuzzy search on our term, kinda. Not sure why the ** are
         # Required but it will do an exact search without them.

SoftLayer/utils.py

@@ -3,8 +3,8 @@
     ~~~~~~~~~~~~~~~
     Utility function/classes.
 
-    :license: MIT, see LICENSE for more details.
 """
+
 import collections
 import datetime
 from json import JSONDecoder
@@ -247,7 +247,6 @@ class IdentifierMixin(object):
 
     This mixin provides an interface to provide multiple methods for
     converting an 'indentifier' to an id
-
     """
     resolvers = []
 
@@ -375,7 +374,7 @@ def verify_date(date):
     """Verify if the date format is correct
 
     :param string date: A date in format string
-    :return a exception if the date is not the correct format
+    :return Exception: a exception if the date is not the correct format
     """
     try:
         date = datetime.datetime.strptime(date, '%m/%d/%Y')

docs/_static/SoftLayer-Python.drawio

@@ -0,0 +1,5 @@
+.. _slsearch:
+
+.. automodule:: SoftLayer.managers.search
+   :members:
+   :inherited-members:

docs/_static/SoftLayer-Python.png

@@ -36,8 +36,8 @@ Can be called with an un-authenticated API call.
     :prog: metadata
     :show-nested:
 
-search
-========
+Search
+======
 
 Is an API service that lets you make complex queries about data indexed by the service.
 Can be called with an un-authenticated API call.

docs/api/managers/autoscale.rst

@@ -1,7 +1,7 @@
 .. _cli_security:
 
 SSH Keys and SSL Certificates
-========
+=============================
 
 .. click:: SoftLayer.CLI.security.sshkey_add:cli
     :prog: security sshkey-add