about summary refs log tree commit diff stats
path: root/apidocs/python
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/python')
-rw-r--r--apidocs/python/conf.py3
-rw-r--r--apidocs/python/src/prof.py34
2 files changed, 22 insertions, 15 deletions
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
='#n143'>143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304