Add documentation about CLI options

jlesquembre · Feb 4, 2016 · 555e845 · 555e845
1 parent db7c54b
commit 555e845
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -53,7 +53,7 @@ def __getattr__(cls, name):
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage',
               'sphinx.ext.pngmath', 'sphinx.ext.mathjax',
-              'sphinx.ext.intersphinx']
+              'sphinx.ext.intersphinx', 'sphinxcontrib.programoutput']
 
 if not on_rtd:
     extensions += ['sphinxcontrib.spelling']

diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -119,3 +119,20 @@ version number manually, autopilot will check that the number is a valid number
 
 Also notice that when you update your release version number, autopilot will
 automatically update the next development version number.
+
+
+Command line options
+--------------------
+
+You can append `--help` to any command to get a description of the command.
+
+.. command-output:: ap --help
+
+.. command-output:: ap new --help
+
+.. command-output:: ap release --help
+
+
+The ``--type`` option is used to generate the next version number, but you can
+always modify this number on the ncurses interface, before the new release is
+created.
diff --git a/requirements.txt b/requirements.txt
@@ -5,6 +5,7 @@ Sphinx
 sphinx_rtd_theme
 sphinxcontrib-napoleon
 sphinxcontrib-spelling
+sphinxcontrib-programoutput
 pyenchant
 tox
 devpi-client