make our API docstrings more epydoc friendly

[htsworkflow.git] / htsworkflow / pipelines / firecrest.py

diff --git a/htsworkflow/pipelines/firecrest.py b/htsworkflow/pipelines/firecrest.py
index 4fbde5d517ac661cfecd68ff8ab2fff2472f5d9f..847f608bcb5be87832266037dfc9350d1b61b128 100644 (file)
--- a/htsworkflow/pipelines/firecrest.py
+++ b/htsworkflow/pipelines/firecrest.py
@@ -1,10 +1,13 @@
 """
 Extract information about the Firecrest run
 
-Firecrest - class holding the properties we found
-firecrest - Firecrest factory function initalized from a directory name
-fromxml - Firecrest factory function initalized from an xml dump from
-          the Firecrest object.
+Firecrest 
+  class holding the properties we found
+firecrest 
+  Firecrest factory function initalized from a directory name
+fromxml 
+  Firecrest factory function initalized from an xml dump from
+  the Firecrest object.
 """
 
 from datetime import date
@@ -17,6 +20,8 @@ from htsworkflow.pipelines.runfolder import \
    VERSION_RE, \
    EUROPEAN_STRPTIME
 
+__docformat__ = "restructuredtext en"
+
 class Firecrest(object):
     XML_VERSION=1