diff options
| author | James Booth <boothj5@gmail.com> | 2016-07-30 23:16:57 +0100 |
|---|---|---|
| committer | James Booth <boothj5@gmail.com> | 2016-07-30 23:16:57 +0100 |
| commit | 49a213b38248757a3dccf84b91348081fb676eb5 (patch) | |
| tree | 5f8d2cf94eb65394a13cc790a3a2caefaa225cb0 | |
| parent | 43b1d7f7cd4e753effe3c15f0724798077638ff3 (diff) | |
| download | profani-tty-49a213b38248757a3dccf84b91348081fb676eb5.tar.gz | |
Update python API docs
| -rw-r--r-- | apidocs/python/conf.py | 4 | ||||
| -rw-r--r-- | apidocs/python/index.rst | 3 |
2 files changed, 5 insertions, 2 deletions
diff --git a/apidocs/python/conf.py b/apidocs/python/conf.py index 895c8b72..9d2d20a0 100644 --- a/apidocs/python/conf.py +++ b/apidocs/python/conf.py @@ -109,8 +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 = 'sphinx_rtd_theme' -# 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/index.rst b/apidocs/python/index.rst index 95362f98..a60846c8 100644 --- a/apidocs/python/index.rst +++ b/apidocs/python/index.rst @@ -1,6 +1,9 @@ Profanity Python Plugins API ============================ +The ``prof`` module describes functions that plugins may call to interact with Profanity. +The ``plugin`` module describes functions that plugins may define to be notified of various events in Profanity. + Contents: .. toctree:: |