Skip to content

Commit

Permalink
Reworded the docs frontpage.
Browse files Browse the repository at this point in the history
  • Loading branch information
epsy committed Mar 11, 2015
1 parent 8d36db3 commit f50402e
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
clize: Turn functions into command-line interfaces
**************************************************

Clize is an argument parser for `Python <https://www.python.org/>`:
Clize is an argument parser for `Python <https://www.python.org/>`_:

* Create command-line interfaces by passing your functions to `clize.run`
* Automatic help generation sourced from the functions' docstrings
* Subcommand dispatching
* Decorator support
* Support for extensions
* Automatic help generation sourced from your functions' docstrings
* Dispatch to multiple commands by passing multiple functions to `clize.run`
* Reuse functionality through Python decorators
* Extend it to suit unusual kinds of parameters

Example
-------
Expand Down Expand Up @@ -46,11 +46,10 @@ interface for it:
Where to start?
---------------

* Follow the :ref:`tutorial <basics>`
* Browse the |examples_url|_
* Read about :ref:`the intentions behind clize<why>`
* :ref:`Tutorial <basics>`
* Browse the |examples_url|_.
* :ref:`reference`
* `GitHub <https://github.com/epsy/clize>`_
* Star, watch or fork Clize on `GitHub <https://github.com/epsy/clize>`_


.. toctree::
Expand Down

0 comments on commit f50402e

Please sign in to comment.