From 7dd754d344633161cb75e12fa76e3c833269bddb Mon Sep 17 00:00:00 2001
From: James Booth <boothj5@gmail.com>
Date: Fri, 29 Jul 2016 01:01:54 +0100
Subject: Updates to python docs

---
 apidocs/python/conf.py     |  3 ++-
 apidocs/python/src/prof.py | 34 ++++++++++++++++++++--------------
 2 files changed, 22 insertions(+), 15 deletions(-)

(limited to 'apidocs/python')

diff --git a/apidocs/python/conf.py b/apidocs/python/conf.py
index 8636d2bd..895c8b72 100644
--- a/apidocs/python/conf.py
+++ b/apidocs/python/conf.py
@@ -109,7 +109,8 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
+# html_theme = 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py
index 0fa478fb..cb5d3c2c 100644
--- a/apidocs/python/src/prof.py
+++ b/apidocs/python/src/prof.py
@@ -9,27 +9,33 @@ def cons_alert():
     pass
 
 def cons_show(message): 
+    """Show a message in the console window.
+
+    :param message: the message to print
+    :return: ``True`` on success, ``False`` on failure
     """
-    Show a message in the console.\n
-    *message*: The message to print\n 
-    Return: True on success, False on failure
+    pass
+
+def cons_show_themed(group, item, default, message): 
+    """Show a message in the console, using the specified theme.\n
+    Themes can be must be specified in ``~/.local/share/profanity/plugin_themes``
+
+    :param group: the group name in the themes file, or None
+    :param item: the item name within the group, or None
+    :param default: default colour if the theme cannot be found, or None
+    :param message: the message to print
+    :return: ``True`` on success, ``False`` on failure
     """
     pass
 
-def cons_show_themed(): 
-    """\n	
-    Show a message in the console, using the specified theme.
-    | Themes can be must be specified in ~/.local/share/profanity/plugin_themes\n
-    *group* The group name in the themes file, or NULL\n
-    *item* The item name within the group, or NULL\n
-    *def* A default colour if the theme cannot be found, or NULL\n
-    *message* the message to print\n
-    Return: True on success, False on failure
+
+def cons_bad_cmd_usage(command): 
+    """Show a message indicating the command has been called incorrectly.
+
+    :param command: the command name with leading slash, e.g. ``"/say"``
     """
     pass
 
-def cons_bad_cmd_usage(): 
-	pass
 
 def register_command(): 
 	pass
-- 
cgit 1.4.1-2-gfad0