mirror of
https://github.com/profanity-im/profanity.git
synced 2024-12-04 14:46:46 -05:00
Updates to python docs
This commit is contained in:
parent
a308f5e4f1
commit
7dd754d344
@ -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
|
||||
|
@ -9,27 +9,33 @@ def cons_alert():
|
||||
pass
|
||||
|
||||
def cons_show(message):
|
||||
"""
|
||||
Show a message in the console.\n
|
||||
*message*: The message to print\n
|
||||
Return: True on success, False on failure
|
||||
"""Show a message in the console window.
|
||||
|
||||
: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_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_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
|
||||
|
Loading…
Reference in New Issue
Block a user