enhance documentation

- flatten hierarchy (some links do not work when using folders)
+ fix a bug with the redorder flag in Override
+ allow removal of parameters
+ clean description using inspect.cleandoc

Change-Id: I3dde4f4cb29c46e8a21014f1fad7aa3ad610a1bf

secop_psi/ppms.py

@@ -136,8 +136,8 @@ class Main(Communicator):
 class PpmsMixin(HasIodev, Module):
     """common methods for ppms modules"""
 
-    properties = {
-        'iodev': Attached(),
+    parameters = {
+        'pollinterval': None,
     }
 
     pollerClass = Poller
@@ -186,8 +186,6 @@ class Channel(PpmsMixin, Readable):
         'enabled':
             Parameter('is this channel used?', readonly=False, poll=False,
                       datatype=BoolType(), default=False),
-        'pollinterval':
-            Override(visibility=3),
     }
     properties = {
         'channel':
@@ -210,13 +208,9 @@ class Channel(PpmsMixin, Readable):
 class UserChannel(Channel):
     """user channel"""
 
-    parameters = {
-        'pollinterval':
-            Override(visibility=3),
-    }
     properties = {
         'no':
-            Property('channel number',
+            Property('*(unused)*',
                      datatype=IntRange(0, 0), export=False, default=0),
         'linkenable':
             Property('name of linked channel for enabling',
@@ -243,8 +237,6 @@ class DriverChannel(Channel):
         'powerlimit':
             Parameter('power limit', readonly=False, handler=drvout,
                       datatype=FloatRange(0., 1000., unit='uW')),
-        'pollinterval':
-            Override(visibility=3),
     }
 
     def analyze_drvout(self, no, current, powerlimit):
@@ -281,8 +273,6 @@ class BridgeChannel(Channel):
         'voltagelimit':
             Parameter('voltage limit', readonly=False, handler=bridge,
                       datatype=FloatRange(0.0001, 100., unit='mV')),
-        'pollinterval':
-            Override(visibility=3),
     }
 
     def analyze_bridge(self, no, excitation, powerlimit, dcflag, readingmode, voltagelimit):
@@ -312,8 +302,6 @@ class Level(PpmsMixin, Readable):
     parameters = {
         'value':  Override(datatype=FloatRange(unit='%'), handler=level),
         'status': Override(handler=level),
-        'pollinterval':
-            Override(visibility=3),
     }
 
     channel = 'level'
@@ -370,8 +358,6 @@ class Chamber(PpmsMixin, Drivable):
         'target':
             Override(description='chamber command', handler=chamber,
                      datatype=EnumType(Operation)),
-        'pollinterval':
-            Override(visibility=3),
     }
     STATUS_MAP = {
         StatusCode.purged_and_sealed: (Status.IDLE, 'purged and sealed'),
@@ -435,8 +421,6 @@ class Temp(PpmsMixin, Drivable):
         'approachmode':
             Parameter('how to approach target!', readonly=False, handler=temp,
                       datatype=EnumType(ApproachMode)),
-        'pollinterval':
-            Override(visibility=3),
         'timeout':
             Parameter('drive timeout, in addition to ramp time', readonly=False,
                       datatype=FloatRange(0, unit='sec'), default=3600),
@@ -632,8 +616,6 @@ class Field(PpmsMixin, Drivable):
         'persistentmode':
             Parameter('what to do after changing field', readonly=False, handler=field,
                       datatype=EnumType(PersistentMode)),
-        'pollinterval':
-            Override(visibility=3),
     }
 
     STATUS_MAP = {
@@ -763,8 +745,6 @@ class Position(PpmsMixin, Drivable):
         'speed':
             Parameter('motor speed', readonly=False, handler=move,
                       datatype=FloatRange(0.8, 12, unit='deg/sec')),
-        'pollinterval':
-            Override(visibility=3),
     }
     STATUS_MAP = {
         1: (Status.IDLE, 'at target'),