Added a parameter reference.

clize/extra/parameters.py

@@ -170,6 +170,14 @@ def unsatisfied(self, ba):
 
 
 def multi(min=0, max=None):
+    """For option parameters, allows the parameter to be repeated on the
+    command-line with an optional minimum or maximum. For ``*args``-like
+    parameters, just adds the optional bounds.
+
+    .. literalinclude:: /../examples/extra/multi.py
+        :lines: 6-14
+    """
+
     return parser.use_class(
         named=MultiOptionParameter, varargs=parser.ExtraPosArgsParameter,
         kwargs={
@@ -383,13 +391,7 @@ def argument_decorator(f):
     to qualify another.
 
     .. literalinclude:: /../examples/extra/argdeco.py
-        :lines:5-25
-
-    ::
-
-        $ python argdeco.py abc -c def ghi
-        abc DEF ghi
-
+       :lines: 5-25
     """
     return parser.use_mixin(
         DecoratedArgumentParameter, kwargs={'decorator': f})

clize/parser.py

@@ -41,6 +41,8 @@ class Parameter(object):
     processed as positional."""
 
     I = IGNORE = ParameterFlag('IGNORE')
+    """Annotate a parameter with this and it will be dropped from the
+    resulting CLI signature."""
 
     U = UNDOCUMENTED = ParameterFlag('UNDOCUMENTED')
     """Parameters annotated with this will be omitted from the

docs/index.rst

@@ -43,7 +43,7 @@ Contents
    multicommands
    compositing
    packaging
-   moreparams
+   params
    newparams
    api
    upgrade

docs/newparams.rst

@@ -1,8 +1,14 @@
 .. module:: clize.parser
 
+
+.. _extending parser:
+
 Extending the parser
 ====================
 
+
+.. _parser overview:
+
 Execution overview
 ------------------
 
@@ -23,6 +29,8 @@ Execution overview
    prints it.
 
 
+.. _parameter conversion:
+
 Parameter conversion
 --------------------
 
@@ -77,6 +85,8 @@ The default parameter converter works as follows:
     handle it.
 
 
+.. _parser description:
+
 The argument parser
 -------------------
 
@@ -105,6 +115,8 @@ and `~.CliBoundArguments.skip` can also be modified to change the ongoing
 argument reading process.
 
 
+.. _new param example:
+
 Example: Creating a parameter class for specifying log levels
 -------------------------------------------------------------