From d1ee888d9f4760aee77a75df9a211265df0e8569 Mon Sep 17 00:00:00 2001
From: Petr Šplíchal <psplicha@redhat.com>
Date: Tue, 21 Feb 2012 16:57:26 +0100
Subject: Documentation (man page and coverage overview)

---
 documentation/nitrate.rst | 62 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 documentation/nitrate.rst

(limited to 'documentation/nitrate.rst')

diff --git a/documentation/nitrate.rst b/documentation/nitrate.rst
new file mode 100644
index 0000000..f32a1a6
--- /dev/null
+++ b/documentation/nitrate.rst
@@ -0,0 +1,62 @@
+
+==================================================================
+ nitrate
+==================================================================
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ Python API for the Nitrate test case management system
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:Manual section: 1
+
+
+SYNOPSIS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+nitrate
+
+
+DESCRIPTION
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+python-nitrate provides a high-level Python interface to the
+Nitrate test case management system. The package also provides
+standalone script 'nitrate' which allows easy experimenting with
+the interface directly from the Python interpreter by importing
+all available objects and enabling the readline support. In short,
+after setting your configuration you can directly manipulate all
+nitrate objects, for example::
+
+    $ nitrate
+    >>> for case in TestRun(123):
+    ...     print case
+
+
+CONFIGURATION
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To be able to contact the Nitrate server a minimal user config
+file ~/.nitrate has to be provided in the user home directory::
+
+    [nitrate]
+    url = https://nitrate.server/xmlrpc/
+
+
+SEE ALSO
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For more detailed and most up-to-date description of all available
+nitrate module features see Python online documentation::
+
+    pydoc nitrate
+
+
+AUTHORS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Written by Petr Splichal <psplicha@redhat.com>. The Python xmlrpc
+driver is based on the work of Airald Hapairai, David Malcolm
+<dmalcolm@redhat.com>, Will Woods <wwoods@redhat.com> and Bill Peck
+<bpeck@redhat.com> and was enhanced by Chenxiong Qi <cqi@redhat.com>,
+Tang Chaobin <ctang@redhat.com>, Yuguang Wang <yuwang@redhat.com> and
+Xuqing Kuang <xuqingkuang@gmail.com>.
-- 
cgit