update doc
- add properties, parameters and commands to the doc string autoatically - change names to "Frappy" - started tutorial - changed doc structure slightly Change-Id: I87bef91384d138c738d12ddcf3a1de7f758a0973
This commit is contained in:
@@ -28,7 +28,7 @@ from collections import OrderedDict
|
||||
from secop.errors import ProgrammingError, BadValueError
|
||||
from secop.params import Command, Override, Parameter
|
||||
from secop.datatypes import EnumType
|
||||
from secop.properties import PropertyMeta
|
||||
from secop.properties import PropertyMeta, add_extra_doc
|
||||
|
||||
|
||||
class Done:
|
||||
@@ -206,6 +206,10 @@ class ModuleMeta(PropertyMeta):
|
||||
raise ProgrammingError('%r: command %r has to be specified '
|
||||
'explicitly!' % (name, attrname[3:]))
|
||||
|
||||
add_extra_doc(newtype, '**parameters**',
|
||||
{k: p for k, p in accessibles.items() if isinstance(p, Parameter)})
|
||||
add_extra_doc(newtype, '**commands**',
|
||||
{k: p for k, p in accessibles.items() if isinstance(p, Command)})
|
||||
attrs['__constructed__'] = True
|
||||
return newtype
|
||||
|
||||
|
||||
Reference in New Issue
Block a user