#1068 doc updates

Author: allmightyspiff

SoftLayer/CLI/hardware/edit.py

@@ -12,25 +12,20 @@
 @click.command()
 @click.argument('identifier')
 @click.option('--domain', '-D', help="Domain portion of the FQDN")
-@click.option('--userfile', '-F',
-              help="Read userdata from file",
-              type=click.Path(exists=True, readable=True, resolve_path=True))
-@click.option('--tag', '-g',
-              multiple=True,
+@click.option('--userfile', '-F', type=click.Path(exists=True, readable=True, resolve_path=True,
+              help="Read userdata from file"))
+@click.option('--tag', '-g', multiple=True,
               help="Tags to set or empty string to remove all")
 @click.option('--hostname', '-H', help="Host portion of the FQDN")
 @click.option('--userdata', '-u', help="User defined metadata string")
-@click.option('--public-speed',
-              help="Public port speed.",
-              default=None,
-              type=click.Choice(['0', '10', '100', '1000', '10000']))
-@click.option('--private-speed',
-              help="Private port speed.",
-              default=None,
-              type=click.Choice(['0', '10', '100', '1000', '10000']))
+@click.option('--public-speed', default=None, 
+              type=click.Choice(['0', '10', '100', '1000', '10000', '-1']
+              help="Public port speed. -1 is best speed available"))
+@click.option('--private-speed', default=None,
+              type=click.Choice(['0', '10', '100', '1000', '10000', '-1']
+              help="Private port speed. -1 is best speed available"))
 @environment.pass_env
-def cli(env, identifier, domain, userfile, tag, hostname, userdata,
-        public_speed, private_speed):
+def cli(env, identifier, domain, userfile, tag, hostname, userdata, public_speed, private_speed):
     """Edit hardware details."""
 
     if userdata and userfile:

SoftLayer/managers/vs_placement.py

@@ -50,13 +50,17 @@ def list(self, mask=None):
     def create(self, placement_object):
         """Creates a placement group
 
-        :param dictionary placement_object: Below are the fields you can specify, taken from
-            https://softlayer.github.io/reference/datatypes/SoftLayer_Virtual_PlacementGroup/
+        A placement_object is defined as::
+
             placement_object = {
                 'backendRouterId': 12345,
                 'name': 'Test Name',
                 'ruleId': 12345
             }
+    
+        -  https://softlayer.github.io/reference/datatypes/SoftLayer_Virtual_PlacementGroup/
+
+        :param dictionary placement_object: 
 
         """
         return self.client.call('SoftLayer_Virtual_PlacementGroup', 'createObject', placement_object)

docs/api/managers/vs_placement.rst

@@ -0,0 +1,5 @@
+.. _vs_placement:
+
+.. automodule:: SoftLayer.managers.vs_placement
+   :members:
+   :inherited-members:

docs/cli.rst

@@ -14,6 +14,7 @@ functionality not fully documented here.
 
    cli/ipsec
    cli/vs
+   cli/hardware
    cli/ordering
    cli/users
 
@@ -34,7 +35,7 @@ To update the configuration, you can use `slcli setup`.
 	:..............:..................................................................:
 	:     Username : username                                                         :
 	:      API Key : oyVmeipYQCNrjVS4rF9bHWV7D75S6pa1fghFl384v7mwRCbHTfuJ8qRORIqoVnha :
-	: Endpoint URL : https://api.softlayer.com/xmlrpc/v3/                             :
+	: Endpoint URL : https://api.softlayer.com/xmlrpc/v3.1/                           :
 	:..............:..................................................................:
 	Are you sure you want to write settings to "/home/me/.softlayer"? [y/N]: y
 
@@ -47,7 +48,7 @@ To check the configuration, you can use `slcli config show`.
 	:..............:..................................................................:
 	:     Username : username                                                         :
 	:      API Key : oyVmeipYQCNrjVS4rF9bHWV7D75S6pa1fghFl384v7mwRCbHTfuJ8qRORIqoVnha :
-	: Endpoint URL : https://api.softlayer.com/xmlrpc/v3/                             :
+	: Endpoint URL : https://api.softlayer.com/xmlrpc/v3.1/                           :
 	:..............:..................................................................:
 
 

docs/cli/hardware.rst

@@ -0,0 +1,3 @@
+.. click:: SoftLayer.CLI.hardware.list:cli
+   :prog: slcli hw list
+   :show-nested:

docs/conf.py

@@ -30,7 +30,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.coverage',
-              'sphinx.ext.viewcode']
+              'sphinx.ext.viewcode',
+              'sphinx_click.ext']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -48,7 +49,7 @@
 project = u'SoftLayer API Python Client'
 # Hack to avoid the "Redefining built-in 'copyright'" error from static
 # analysis tools
-globals()['copyright'] = u'2017, SoftLayer Technologies, Inc.'
+globals()['copyright'] = u'2019, SoftLayer Technologies, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the