From 4b0ace13acc7d123b238b1a910ed0fe40a391668 Mon Sep 17 00:00:00 2001 From: Thibaut Horel Date: Tue, 16 Apr 2013 23:46:01 +0200 Subject: Restructure the documentation --- doc/index.rst | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/index.rst b/doc/index.rst index 96ae17a..5a0dffe 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,9 +1,26 @@ -Home -==== +Python-pushover documentation +============================= -.. toctree:: +.. include:: ../README.rst + :end-line: -7 + +API documentation +----------------- .. automodule:: pushover :members: :undoc-members: :show-inheritance: + + +Command line +------------- + +The module can also be called from the command line for basic message sending. +The minimum invocation is: + +.. code-block:: bash + + python pushover.py --token --client "Hello!" + + -- cgit v1.2.3-70-g09d2