Skip to content

Commit

Permalink
Restructured the docs front page. Everyone loves bullet points.
Browse files Browse the repository at this point in the history
  • Loading branch information
epsy committed Feb 28, 2015
1 parent 2225ccd commit a44bda2
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 21 deletions.
45 changes: 24 additions & 21 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
*******************************************************
clize: Command-line argument parsing without the effort
*******************************************************
**************************************************
clize: Turn functions into command-line interfaces
**************************************************

Clize procedurally turns your python functions into convenient command-line
interfaces.
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

Example
-------

.. literalinclude:: /../examples/hello.py
:emphasize-lines: 3,20-21

`~clize.run` takes the function and automatically produces a command-line
interface for it:

.. code-block:: console
$ pip install --user clize
Expand All @@ -31,27 +42,19 @@ interfaces.
$ python hello.py --no-capitalize
Hello john!
Clize distinguishes itself from other argument parsers in that it lets you
focus on your program's main behavior rather than on its argument parsing. You
simply write the function you could have written anyway and pass it to
`clize.run`.

You can check out the |examples_url|_ folder, or you can start the tutorial at
the :ref:`basics`.

Clize doesn't stop there however: It supports :ref:`dispatching to multiple
commands <dispatching>`, :ref:`composing multiple functions
<function-compositing>`, and is :ref:`extensible <extending parser>`.
You may also consult documentation for each kind of parameter in the
:ref:`reference`.
Where to start?
---------------

* Read about :ref:`the intentions behind clize<why>`
* :ref:`Tutorial <basics>`
* Browse the |examples_url|_.
* :ref:`reference`
* `GitHub <https://github.com/epsy/clize>`_

Table of contents
-----------------

.. toctree::
:maxdepth: 2
:hidden:

why
basics
Expand Down
2 changes: 2 additions & 0 deletions docs/why.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _why:

Why Clize
=========

Expand Down

0 comments on commit a44bda2

Please sign in to comment.