(self,
                 first_line=None,
                 optional_sections=('raise', 'also', 'ref', 'note', 'other', 'example', 'method', 'attr'),
                 excluded_sections=())
:param first_line: indicate if description should start
          on first or second line. By default it will follow global config.
        :type first_line: boolean
        :param optional_sections: list of sections that are not mandatory
          if empty. The accepted sections are:
          -param
          -return
          -raise
          -also
          -ref
          -note
          -other
          -example
          -method
          -attr
        :type optional_sections: list
        :param excluded_sections: list of sections that are excluded,
          even if mandatory. The list is the same than for optional sections.
        :type excluded_sections: list
:param first_line: indicate if description should start
          on first or second line. By default it will follow global config.
        :type first_line: boolean
        :param optional_sections: list of sections that are not mandatory
          if empty. The accepted sections are:
          -param
          -return
          -raise
          -also
          -ref
          -note
          -other
          -example
          -method
          -attr
        :type optional_sections: list
        :param excluded_sections: list of sections that are excluded,
          even if mandatory. The list is the same than for optional sections.
        :type excluded_sections: list
: param first_line : indicate if description should start on first or second line . By default it will follow global config . : type first_line : boolean : param optional_sections : list of sections that are not mandatory if empty . The accepted sections are : - param - return - raise - also - ref - note - other - example - method - attr : type optional_sections : list : param excluded_sections : list of sections that are excluded even if mandatory . The list is the same than for optional sections . : type excluded_sections : list
def __init__(self,
                 first_line=None,
                 optional_sections=('raise', 'also', 'ref', 'note', 'other', 'example', 'method', 'attr'),
                 excluded_sections=()):
        '''
        :param first_line: indicate if description should start
          on first or second line. By default it will follow global config.
        :type first_line: boolean
        :param optional_sections: list of sections that are not mandatory
          if empty. The accepted sections are:
          -param
          -return
          -raise
          -also
          -ref
          -note
          -other
          -example
          -method
          -attr
        :type optional_sections: list
        :param excluded_sections: list of sections that are excluded,
          even if mandatory. The list is the same than for optional sections.
        :type excluded_sections: list

        '''
        super(NumpydocTools, self).__init__(first_line=first_line,
                                            optional_sections=optional_sections,
                                            excluded_sections=excluded_sections,
                                            opt={
                                                'also': 'see also',
                                                'attr': 'attributes',
                                                'example': 'examples',
                                                'method': 'methods',
                                                'note': 'notes',
                                                'other': 'other parameters',
                                                'param': 'parameters',
                                                'raise': 'raises',
                                                'ref': 'references',
                                                'return': 'returns',
                                            },
                                            section_headers={
                                                'param': 'Parameters',
                                                'return': 'Returns',
                                                'raise': 'Raises',
                                            },
                                            )

        self.keywords = [
            ':math:',
            '.. math::',
            'see also',
            '.. image::',
        ]
def __init__ ( self , first_line = None , optional_sections = ( 'raise' , 'also' , 'ref' , 'note' , 'other' , 'example' , 'method' , 'attr' ) , excluded_sections = ( ) ) : super ( NumpydocTools , self ) . __init__ ( first_line = first_line , optional_sections = optional_sections , excluded_sections = excluded_sections , opt = { 'also' : 'see also' , 'attr' : 'attributes' , 'example' : 'examples' , 'method' : 'methods' , 'note' : 'notes' , 'other' : 'other parameters' , 'param' : 'parameters' , 'raise' : 'raises' , 'ref' : 'references' , 'return' : 'returns' , } , section_headers = { 'param' : 'Parameters' , 'return' : 'Returns' , 'raise' : 'Raises' , } , ) self . keywords = [ ':math:' , '.. math::' , 'see also' , '.. image::' , ]