add documentation to clustalw binding

modules/bindings/doc/bindings.rst

@@ -17,3 +17,4 @@ So far, the binding module includes:
   blast
   msms
   tmtools
+  clustalw

modules/bindings/doc/clustalw.rst

+:mod:`~ost.bindings.clustalw` - Perform multiple sequence alignment
+================================================================================
+
+.. module:: ost.bindings.clustalw
+  :synopsis: Perform multiple sequence alignment
+
+
+.. autofunction:: ost.bindings.clustalw.ClustalW

modules/bindings/pymod/clustalw.py

@@ -5,6 +5,46 @@ import subprocess
 
 def ClustalW(seq1, seq2=None, clustalw=None, keep_files=False, nopgap=False, 
              clustalw_option_string=False):
+  '''
+  Runs a clustalw multiple sequence alignment. The results are returned as a
+  :class:`~ost.seq.AlignmentHandle` instance.
+  
+  There are two ways to use this function:
+  
+   - align exactly two sequences:
+   
+      :param seq1: sequence_one
+      :type seq1: :class:`~ost.seq.SequenceHandle` or :class:`str`
+      
+      :param seq2: sequence_two
+      :type seq2: :class:`~ost.seq.SequenceHandle` or :class:`str`
+  
+      The two sequences can be specified as two separate function parameters 
+      (`seq1`, `seq2`). The type of both parameters can be either
+      :class:`~ost.seq.SequenceHandle` or :class:`str`, but must be the same for
+      both parameters.
+      
+   - align two or more sequences:
+   
+      :param seq1: sequence_list
+      :type seq1: :class:`~ost.seq.SequenceList`
+      
+      :param seq2: must be :class:`None`
+      
+      Two or more sequences can be specified by using a
+      :class:`~ost.seq.SequenceList`. It is then passed as the first function 
+      parameter (`seq1`). The second parameter (`seq2`) must be :class:`None`.
+      
+       
+  :param clustalw: path to clustalw executable (used in :func:`~ost.settings.Locate`)
+  :type clustalw: :class:`str`
+  :param nopgap: turn residue-specific gaps off
+  :type nopgap: :class:`bool`
+  :param clustalw_option_string: additional clustalw flags (see http://toolkit.tuebingen.mpg.de/clustalw/help_params)
+  :type clustalw_option_string: :class:`str`
+  :param keep_files: do not delete temporary files
+  :type keep_files: :class:`bool`
+  '''
   clustalw_path=settings.Locate(('clustalw', 'clustalw2'), 
                                 explicit_file_name=clustalw)