I'm using Sphinx 1.4.4 for documenting Python modules in HTML output.
If I have a class method, e.g.
def CreateMask( self, image, model_mask, conts = None,
trans = None, thres_dist = 4, mser = None,
mask_mode = MASK_OVERFLOWN | MASK_LARGE, **kwargs ):
'''
Create mask image - mask out overflown image areas
:param image: ID of image to create mask for
:param model_mask: ID of image to create mask in
:param conts: List with contours to mask image with ->
neglect other parameters
:param trans: Transformation to estimate spot size with
:param thres_dist: Enlarge detected objects by this distance
:param mser: icono.MSER reference to reuse existing tree if
set
:param mask_mode: Bitwise or MASK_OVERFLOWN, MASK_LARGE,
MASK_SMALL
'''
the resulting HTML output will be the one listed below (this seems to
depend on the **kwargs parameter). Is there any configuration parameter I
can set to get the complete parameter list in the function definition?
CreateMask*(***args*, ***kwargs**)*
Create mask image - mask out overflown image areas
Parameters: *image* -- ID of image to create mask for
*model_mask* -- ID of image to create mask in
*conts* -- List with contours to mask image with -> neglect other parameters
*trans* -- Transformation to estimate spot size with
*thres_dist* -- Enlarge detected objects by this distance
*mser* -- icono.MSER reference to reuse existing tree if set
*mask_mode* -- Bitwise or MASK_OVERFLOWN, MASK_LARGE, MASK_SMALL
Thanks for any help,
Matt
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
