diff options
| author | Thibaut Horel <thibaut.horel@gmail.com> | 2013-04-16 23:46:01 +0200 |
|---|---|---|
| committer | Thibaut Horel <thibaut.horel@gmail.com> | 2013-04-16 23:46:01 +0200 |
| commit | 4b0ace13acc7d123b238b1a910ed0fe40a391668 (patch) | |
| tree | 4da66ec20545beaf39bf9c4b9b5cfd807b08bd50 /doc/index.rst | |
| parent | 7adcac4cf9e86fed4aa9f91631544d7e5bce48a7 (diff) | |
| download | python-pushover-4b0ace13acc7d123b238b1a910ed0fe40a391668.tar.gz | |
Restructure the documentation
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 23 |
1 files changed, 20 insertions, 3 deletions
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 <app-token> --client <client-id> "Hello!" + + |