Fix documentation warnings, add navigation to all pages

Author: UniversalSuperBox

ciscosparkapi/api/messages.py

@@ -137,7 +137,7 @@ def create(self, roomId=None, toPersonId=None, toPersonEmail=None,
                 specified this parameter may be optionally used to provide
                 alternate text for UI clients that do not support rich text.
             markdown(basestring): The message, in markdown format.
-            files(list): A list of public URL(s) or local path(s) to files to
+            files(`list`): A list of public URL(s) or local path(s) to files to
                 be posted into the room. Only one file is allowed per message.
                 Uploaded files are automatically converted into a format that
                 all Spark clients can render.

ciscosparkapi/api/people.py

@@ -123,16 +123,16 @@ def create(self, emails, displayName=None, firstName=None, lastName=None,
         Only an admin can create a new user account.
 
         Args:
-            emails(list): Email address(es) of the person (list of strings).
+            emails(`list`): Email address(es) of the person (list of strings).
             displayName(basestring): Full name of the person.
             firstName(basestring): First name of the person.
             lastName(basestring): Last name of the person.
             avatar(basestring): URL to the person's avatar in PNG format.
             orgId(basestring): ID of the organization to which this
                 person belongs.
-            roles(list): Roles of the person (list of strings containing
+            roles(`list`): Roles of the person (list of strings containing
                 the role IDs to be assigned to the person).
-            licenses(list): Licenses allocated to the person (list of
+            licenses(`list`): Licenses allocated to the person (list of
                 strings - containing the license IDs to be allocated to the
                 person).
             **request_parameters: Additional request parameters (provides
@@ -211,16 +211,16 @@ def update(self, personId, emails=None, displayName=None, firstName=None,
 
         Args:
             personId(basestring): The person ID.
-            emails(list): Email address(es) of the person (list of strings).
+            emails(`list`): Email address(es) of the person (list of strings).
             displayName(basestring): Full name of the person.
             firstName(basestring): First name of the person.
             lastName(basestring): Last name of the person.
             avatar(basestring): URL to the person's avatar in PNG format.
             orgId(basestring): ID of the organization to which this
                 person belongs.
-            roles(list): Roles of the person (list of strings containing
+            roles(`list`): Roles of the person (list of strings containing
                 the role IDs to be assigned to the person).
-            licenses(list): Licenses allocated to the person (list of
+            licenses(`list`): Licenses allocated to the person (list of
                 strings - containing the license IDs to be allocated to the
                 person).
             **request_parameters: Additional request parameters (provides

docs/conf.py

@@ -62,7 +62,9 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'collapse_navigation': False
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -90,7 +92,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

docs/index.rst

@@ -54,7 +54,7 @@ What is Cisco Spark?
 --------------------
 
     "Cisco Spark is where all your work lives.  Bring your teams together in a
-     place that makes it easy to keep people and work connected."
+    place that makes it easy to keep people and work connected."
 
 Check out the official `Cisco Spark`_ website for more information and to
 create a free account!

docs/user/api.rst

@@ -104,7 +104,7 @@ roles
 .. _events:
 
 events
------
+------
 
 .. autoclass:: ciscosparkapi.api.events.EventsAPI()
 

docs/user/intro.rst

@@ -136,7 +136,7 @@ Head over to the :ref:`Quickstart` page to begin working with the
 **Cisco Spark APIs in native Python**!
 
 
-.. _License:
+.. _MITLicense:
 
 MIT License
 -----------