Module Expr Str ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias alias ImportFrom alias ClassDef bases Call NameLoad Str TupleLoad Str Str body Expr Str Assign NameStore TupleLoad FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Return Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body Pass decorator_list ClassDef bases NameLoad body FunctionDef arguments args NameParam defaults body Assign NameStore Call NameLoad Assign NameStore Call NameLoad Call NameLoad Call NameLoad AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword Str keyword Str keyword NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body Assign NameStore ListLoad TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str FunctionDef arguments args NameParam defaults body Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad keyword NameLoad For TupleStore NameStore NameStore AttributeLoad NameLoad attr body Assign NameStore Call NameLoad Call NameLoad Call NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore ListLoad TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str For TupleStore NameStore NameStore NameLoad body Assign NameStore Call NameLoad Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore ListLoad TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str For TupleStore NameStore NameStore NameLoad body Assign NameStore Call NameLoad Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Str Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body Assign NameStore ListLoad TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str FunctionDef arguments args NameParam defaults body Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad keyword NameLoad For TupleStore NameStore NameStore AttributeLoad NameLoad attr body Assign NameStore Call NameLoad Call NameLoad Call NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad Call NameLoad NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Str Assign NameStore Call NameLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad NameLoad Str Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad NameLoad Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad NameLoad Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore ListLoad TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str For TupleStore NameStore NameStore NameLoad body Assign NameStore Call NameLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad NameLoad Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad NameLoad Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore ListLoad TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str TupleLoad Str Str For TupleStore NameStore NameStore NameLoad body Assign NameStore Call NameLoad Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Str Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Str Assign NameStore Call NameLoad keyword NameLoad Assign NameStore Call NameLoad Call NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Str Assign NameStore Call NameLoad Call NameLoad NameLoad Assign NameStore Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list decorator_list
N/A N/A 
    test_napoleon_docstring
    ~~~~~~~~~~~~~~~~~~~~~~~

    Tests for :mod:`sphinx.ext.napoleon.docstring` module.


    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
 collections namedtuple inspect cleandoc textwrap dedent unittest TestCase sphinx.ext.napoleon Config sphinx.ext.napoleon.docstring GoogleDocstring NumpyDocstring util mock NamedtupleSubclass N/A N/A namedtuple NamedtupleSubclass N/A attr1 attr2 N/A N/A Sample namedtuple subclass

    Attributes
    ----------
    attr1 : Arbitrary type
        Quick description of attr1
    attr2 : Another arbitrary type
        Quick description of attr2
    attr3 : Type

        Adds a newline after the type

     N/A __slots__ N/A __new__ N/A N/A cls attr1 attr2 N/A None N/A N/A N/A N/A N/A super NamedtupleSubclass cls __new__ cls attr1 attr2 N/A N/A BaseDocstringTest N/A TestCase N/A N/A N/A NamedtupleSubclassTest N/A BaseDocstringTest N/A test_attributes_docstring N/A N/A self N/A N/A N/A config N/A Config N/A actual N/A str N/A NumpyDocstring N/A cleandoc N/A NamedtupleSubclass __doc__ config config app None what class name NamedtupleSubclass obj NamedtupleSubclass N/A expected Sample namedtuple subclass

.. attribute:: attr1

   *Arbitrary type* -- Quick description of attr1

.. attribute:: attr2

   *Another arbitrary type* -- Quick description of attr2

.. attribute:: attr3

   *Type* -- Adds a newline after the type
 N/A N/A N/A self assertEqual expected actual N/A N/A GoogleDocstringTest N/A BaseDocstringTest N/A N/A docstrings N/A N/A Single line summary Single line summary N/A 
        Single line summary

        Extended description

         
        Single line summary

        Extended description
         N/A 
        Single line summary

        Args:
          arg1(str):Extended
            description of arg1
         
        Single line summary

        :Parameters: **arg1** (*str*) -- Extended
                     description of arg1
         N/A 
        Single line summary

        Args:
          arg1(str):Extended
            description of arg1
          arg2 ( int ) : Extended
            description of arg2

        Keyword Args:
          kwarg1(str):Extended
            description of kwarg1
          kwarg2 ( int ) : Extended
            description of kwarg2 
        Single line summary

        :Parameters: * **arg1** (*str*) -- Extended
                       description of arg1
                     * **arg2** (*int*) -- Extended
                       description of arg2

        :Keyword Arguments: * **kwarg1** (*str*) -- Extended
                              description of kwarg1
                            * **kwarg2** (*int*) -- Extended
                              description of kwarg2
         N/A 
        Single line summary

        Arguments:
          arg1(str):Extended
            description of arg1
          arg2 ( int ) : Extended
            description of arg2

        Keyword Arguments:
          kwarg1(str):Extended
            description of kwarg1
          kwarg2 ( int ) : Extended
            description of kwarg2 
        Single line summary

        :Parameters: * **arg1** (*str*) -- Extended
                       description of arg1
                     * **arg2** (*int*) -- Extended
                       description of arg2

        :Keyword Arguments: * **kwarg1** (*str*) -- Extended
                              description of kwarg1
                            * **kwarg2** (*int*) -- Extended
                              description of kwarg2
         N/A 
        Single line summary

        Return:
          str:Extended
          description of return value
         
        Single line summary

        :returns: *str* -- Extended
                  description of return value
         N/A 
        Single line summary

        Returns:
          str:Extended
          description of return value
         
        Single line summary

        :returns: *str* -- Extended
                  description of return value
         N/A 
        Single line summary

        Returns:
          Extended
          description of return value
         
        Single line summary

        :returns: Extended
                  description of return value
         N/A 
        Single line summary

        Args:
          arg1(str):Extended
            description of arg1
          *args: Variable length argument list.
          **kwargs: Arbitrary keyword arguments.
         
        Single line summary

        :Parameters: * **arg1** (*str*) -- Extended
                       description of arg1
                     * **\*args** -- Variable length argument list.
                     * **\*\*kwargs** -- Arbitrary keyword arguments.
         N/A 
        Single line summary

        Yield:
          str:Extended
          description of yielded value
         
        Single line summary

        :Yields: *str* -- Extended
                 description of yielded value
         N/A 
        Single line summary

        Yields:
          Extended
          description of yielded value
         
        Single line summary

        :Yields: Extended
                 description of yielded value
         test_docstrings N/A N/A self N/A N/A N/A config N/A Config napoleon_use_param False napoleon_use_rtype False napoleon_use_keyword False N/A N/A docstring expected N/A self docstrings N/A N/A actual N/A str N/A GoogleDocstring N/A dedent docstring config N/A expected N/A dedent expected N/A N/A N/A self assertEqual expected actual N/A test_parameters_with_class_reference N/A N/A self N/A N/A N/A docstring Construct a new XBlock.

This class should only be used by runtimes.

Arguments:
    runtime (:class:`Runtime`): Use it to access the environment.
        It is available in XBlock code as ``self.runtime``.

    field_data (:class:`FieldData`): Interface used by the XBlock
        fields to access their data from wherever it is persisted.

    scope_ids (:class:`ScopeIds`): Identifiers needed to resolve scopes.

 N/A actual N/A str N/A GoogleDocstring docstring N/A expected Construct a new XBlock.

This class should only be used by runtimes.

:param runtime: Use it to access the environment.
                It is available in XBlock code as ``self.runtime``.
:type runtime: :class:`Runtime`
:param field_data: Interface used by the XBlock
                   fields to access their data from wherever it is persisted.
:type field_data: :class:`FieldData`
:param scope_ids: Identifiers needed to resolve scopes.
:type scope_ids: :class:`ScopeIds`
 N/A N/A N/A self assertEqual expected actual N/A test_attributes_with_class_reference N/A N/A self N/A N/A N/A docstring Attributes:
    in_attr(:class:`numpy.ndarray`): super-dooper attribute
 N/A actual N/A str N/A GoogleDocstring docstring N/A expected .. attribute:: in_attr

   :class:`numpy.ndarray` -- super-dooper attribute
 N/A N/A N/A self assertEqual expected actual N/A docstring Attributes:
    in_attr(numpy.ndarray): super-dooper attribute
 N/A actual N/A str N/A GoogleDocstring docstring N/A expected .. attribute:: in_attr

   *numpy.ndarray* -- super-dooper attribute
 N/A N/A N/A self assertEqual expected actual N/A test_code_block_in_returns_section N/A N/A self N/A N/A N/A docstring 
Returns:
    foobar: foo::

        codecode
        codecode
 N/A expected 
:returns: foo::

              codecode
              codecode
:rtype: foobar
 N/A actual N/A str N/A GoogleDocstring docstring N/A N/A N/A self assertEqual expected actual N/A test_colon_in_return_type N/A N/A self N/A N/A N/A docstring Example property.

Returns:
    :py:class:`~.module.submodule.SomeClass`: an example instance
    if available, None if not available.
 N/A expected Example property.

:returns: an example instance
          if available, None if not available.
:rtype: :py:class:`~.module.submodule.SomeClass`
 N/A actual N/A str N/A GoogleDocstring docstring N/A N/A N/A self assertEqual expected actual N/A test_xrefs_in_return_type N/A N/A self N/A N/A N/A docstring Example Function

Returns:
    :class:`numpy.ndarray`: A :math:`n \times 2` array containing
    a bunch of math items
 N/A expected Example Function

:returns: A :math:`n \times 2` array containing
          a bunch of math items
:rtype: :class:`numpy.ndarray`
 N/A actual N/A str N/A GoogleDocstring docstring N/A N/A N/A self assertEqual expected actual N/A test_raises_types N/A N/A self N/A N/A N/A docstrings N/A N/A 
Example Function

Raises:
    RuntimeError:
        A setting wasn't specified, or was invalid.
    ValueError:
        Something something value error.

 
Example Function

:raises: * :exc:`RuntimeError` -- A setting wasn't specified, or was invalid.
         * :exc:`ValueError` -- Something something value error.
 N/A 
Example Function

Raises:
    InvalidDimensionsError

 
Example Function

:raises: :exc:`InvalidDimensionsError`
 N/A 
Example Function

Raises:
    Invalid Dimensions Error

 
Example Function

:raises: Invalid Dimensions Error
 N/A 
Example Function

Raises:
    Invalid Dimensions Error: With description

 
Example Function

:raises: *Invalid Dimensions Error* -- With description
 N/A 
Example Function

Raises:
    InvalidDimensionsError: If the dimensions couldn't be parsed.

 
Example Function

:raises: :exc:`InvalidDimensionsError` -- If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises:
    Invalid Dimensions Error: If the dimensions couldn't be parsed.

 
Example Function

:raises: *Invalid Dimensions Error* -- If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises:
    If the dimensions couldn't be parsed.

 
Example Function

:raises: If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises:
    :class:`exc.InvalidDimensionsError`

 
Example Function

:raises: :class:`exc.InvalidDimensionsError`
 N/A 
Example Function

Raises:
    :class:`exc.InvalidDimensionsError`: If the dimensions couldn't be parsed.

 
Example Function

:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises:
    :class:`exc.InvalidDimensionsError`: If the dimensions couldn't be parsed,
       then a :class:`exc.InvalidDimensionsError` will be raised.

 
Example Function

:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't be parsed,
         then a :class:`exc.InvalidDimensionsError` will be raised.
 N/A 
Example Function

Raises:
    :class:`exc.InvalidDimensionsError`: If the dimensions couldn't be parsed.
    :class:`exc.InvalidArgumentsError`: If the arguments are invalid.

 
Example Function

:raises: * :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't be parsed.
         * :class:`exc.InvalidArgumentsError` -- If the arguments are invalid.
 N/A 
Example Function

Raises:
    :class:`exc.InvalidDimensionsError`
    :class:`exc.InvalidArgumentsError`

 
Example Function

:raises: * :class:`exc.InvalidDimensionsError`
         * :class:`exc.InvalidArgumentsError`
 N/A N/A docstring expected docstrings N/A N/A actual N/A str N/A GoogleDocstring docstring N/A N/A N/A self assertEqual expected actual N/A test_kwargs_in_arguments N/A N/A self N/A N/A N/A docstring Allows to create attributes binded to this device.

Some other paragraph.

Code sample for usage::

  dev.bind(loopback=Loopback)
  dev.loopback.configure()

Arguments:
  **kwargs: name/class pairs that will create resource-managers
    bound as instance attributes to this instance. See code
    example above.
 N/A expected Allows to create attributes binded to this device.

Some other paragraph.

Code sample for usage::

  dev.bind(loopback=Loopback)
  dev.loopback.configure()

:param \*\*kwargs: name/class pairs that will create resource-managers
                   bound as instance attributes to this instance. See code
                   example above.
 N/A actual N/A str N/A GoogleDocstring docstring N/A N/A N/A self assertEqual expected actual N/A test_section_header_formatting N/A N/A self N/A N/A N/A docstrings N/A N/A 
Summary line

Example:
    Multiline reStructuredText
    literal code block

 
Summary line

.. rubric:: Example

Multiline reStructuredText
literal code block
 N/A 
Summary line

Example::

    Multiline reStructuredText
    literal code block

 
Summary line

Example::

    Multiline reStructuredText
    literal code block
 N/A 
Summary line

:Example:

    Multiline reStructuredText
    literal code block

 
Summary line

:Example:

    Multiline reStructuredText
    literal code block
 N/A N/A docstring expected docstrings N/A N/A actual N/A str N/A GoogleDocstring docstring N/A N/A N/A self assertEqual expected actual N/A test_list_in_parameter_description N/A N/A self N/A N/A N/A docstring One line summary.

Parameters:
    no_list (int):
    one_bullet_empty (int):
        *
    one_bullet_single_line (int):
        - first line
    one_bullet_two_lines (int):
        +   first line
            continued
    two_bullets_single_line (int):
        -  first line
        -  second line
    two_bullets_two_lines (int):
        * first line
          continued
        * second line
          continued
    one_enumeration_single_line (int):
        1.  first line
    one_enumeration_two_lines (int):
        1)   first line
             continued
    two_enumerations_one_line (int):
        (iii) first line
        (iv) second line
    two_enumerations_two_lines (int):
        a. first line
           continued
        b. second line
           continued
    one_definition_one_line (int):
        item 1
            first line
    one_definition_two_lines (int):
        item 1
            first line
            continued
    two_definitions_one_line (int):
        item 1
            first line
        item 2
            second line
    two_definitions_two_lines (int):
        item 1
            first line
            continued
        item 2
            second line
            continued
    one_definition_blank_line (int):
        item 1

            first line

            extra first line

    two_definitions_blank_lines (int):
        item 1

            first line

            extra first line

        item 2

            second line

            extra second line

    definition_after_inline_text (int): text line

        item 1
            first line

    definition_after_normal_text (int):
        text line

        item 1
            first line
 N/A expected One line summary.

:param no_list:
:type no_list: int
:param one_bullet_empty:
                         *
:type one_bullet_empty: int
:param one_bullet_single_line:
                               - first line
:type one_bullet_single_line: int
:param one_bullet_two_lines:
                             +   first line
                                 continued
:type one_bullet_two_lines: int
:param two_bullets_single_line:
                                -  first line
                                -  second line
:type two_bullets_single_line: int
:param two_bullets_two_lines:
                              * first line
                                continued
                              * second line
                                continued
:type two_bullets_two_lines: int
:param one_enumeration_single_line:
                                    1.  first line
:type one_enumeration_single_line: int
:param one_enumeration_two_lines:
                                  1)   first line
                                       continued
:type one_enumeration_two_lines: int
:param two_enumerations_one_line:
                                  (iii) first line
                                  (iv) second line
:type two_enumerations_one_line: int
:param two_enumerations_two_lines:
                                   a. first line
                                      continued
                                   b. second line
                                      continued
:type two_enumerations_two_lines: int
:param one_definition_one_line:
                                item 1
                                    first line
:type one_definition_one_line: int
:param one_definition_two_lines:
                                 item 1
                                     first line
                                     continued
:type one_definition_two_lines: int
:param two_definitions_one_line:
                                 item 1
                                     first line
                                 item 2
                                     second line
:type two_definitions_one_line: int
:param two_definitions_two_lines:
                                  item 1
                                      first line
                                      continued
                                  item 2
                                      second line
                                      continued
:type two_definitions_two_lines: int
:param one_definition_blank_line:
                                  item 1

                                      first line

                                      extra first line
:type one_definition_blank_line: int
:param two_definitions_blank_lines:
                                    item 1

                                        first line

                                        extra first line

                                    item 2

                                        second line

                                        extra second line
:type two_definitions_blank_lines: int
:param definition_after_inline_text: text line

                                     item 1
                                         first line
:type definition_after_inline_text: int
:param definition_after_normal_text: text line

                                     item 1
                                         first line
:type definition_after_normal_text: int
 N/A config N/A Config napoleon_use_param True N/A actual N/A str N/A GoogleDocstring docstring config N/A N/A N/A self assertEqual expected actual N/A expected One line summary.

:Parameters: * **no_list** (*int*)
             * **one_bullet_empty** (*int*) --

               *
             * **one_bullet_single_line** (*int*) --

               - first line
             * **one_bullet_two_lines** (*int*) --

               +   first line
                   continued
             * **two_bullets_single_line** (*int*) --

               -  first line
               -  second line
             * **two_bullets_two_lines** (*int*) --

               * first line
                 continued
               * second line
                 continued
             * **one_enumeration_single_line** (*int*) --

               1.  first line
             * **one_enumeration_two_lines** (*int*) --

               1)   first line
                    continued
             * **two_enumerations_one_line** (*int*) --

               (iii) first line
               (iv) second line
             * **two_enumerations_two_lines** (*int*) --

               a. first line
                  continued
               b. second line
                  continued
             * **one_definition_one_line** (*int*) --

               item 1
                   first line
             * **one_definition_two_lines** (*int*) --

               item 1
                   first line
                   continued
             * **two_definitions_one_line** (*int*) --

               item 1
                   first line
               item 2
                   second line
             * **two_definitions_two_lines** (*int*) --

               item 1
                   first line
                   continued
               item 2
                   second line
                   continued
             * **one_definition_blank_line** (*int*) --

               item 1

                   first line

                   extra first line
             * **two_definitions_blank_lines** (*int*) --

               item 1

                   first line

                   extra first line

               item 2

                   second line

                   extra second line
             * **definition_after_inline_text** (*int*) -- text line

               item 1
                   first line
             * **definition_after_normal_text** (*int*) -- text line

               item 1
                   first line
 N/A config N/A Config napoleon_use_param False N/A actual N/A str N/A GoogleDocstring docstring config N/A N/A N/A self assertEqual expected actual N/A N/A NumpyDocstringTest N/A BaseDocstringTest N/A N/A docstrings N/A N/A Single line summary Single line summary N/A 
        Single line summary

        Extended description

         
        Single line summary

        Extended description
         N/A 
        Single line summary

        Parameters
        ----------
        arg1:str
            Extended
            description of arg1
         
        Single line summary

        :Parameters: **arg1** (*str*) -- Extended
                     description of arg1
         N/A 
        Single line summary

        Parameters
        ----------
        arg1:str
            Extended
            description of arg1
        arg2 : int
            Extended
            description of arg2

        Keyword Arguments
        -----------------
          kwarg1:str
              Extended
              description of kwarg1
          kwarg2 : int
              Extended
              description of kwarg2
         
        Single line summary

        :Parameters: * **arg1** (*str*) -- Extended
                       description of arg1
                     * **arg2** (*int*) -- Extended
                       description of arg2

        :Keyword Arguments: * **kwarg1** (*str*) -- Extended
                              description of kwarg1
                            * **kwarg2** (*int*) -- Extended
                              description of kwarg2
         N/A 
        Single line summary

        Return
        ------
        str
            Extended
            description of return value
         
        Single line summary

        :returns: *str* -- Extended
                  description of return value
         N/A 
        Single line summary

        Returns
        -------
        str
            Extended
            description of return value
         
        Single line summary

        :returns: *str* -- Extended
                  description of return value
         N/A 
        Single line summary

        Parameters
        ----------
        arg1:str
             Extended description of arg1
        *args:
            Variable length argument list.
        **kwargs:
            Arbitrary keyword arguments.
         
        Single line summary

        :Parameters: * **arg1** (*str*) -- Extended description of arg1
                     * **\*args** -- Variable length argument list.
                     * **\*\*kwargs** -- Arbitrary keyword arguments.
         N/A 
        Single line summary

        Yield
        -----
        str
            Extended
            description of yielded value
         
        Single line summary

        :Yields: *str* -- Extended
                 description of yielded value
         N/A 
        Single line summary

        Yields
        ------
        str
            Extended
            description of yielded value
         
        Single line summary

        :Yields: *str* -- Extended
                 description of yielded value
         test_docstrings N/A N/A self N/A N/A N/A config N/A Config napoleon_use_param False napoleon_use_rtype False napoleon_use_keyword False N/A N/A docstring expected N/A self docstrings N/A N/A actual N/A str N/A NumpyDocstring N/A dedent docstring config N/A expected N/A dedent expected N/A N/A N/A self assertEqual expected actual N/A test_parameters_with_class_reference N/A N/A self N/A N/A N/A docstring Parameters
----------
param1 : :class:`MyClass <name.space.MyClass>` instance

 N/A config N/A Config napoleon_use_param False N/A actual N/A str N/A NumpyDocstring docstring config N/A expected :Parameters: **param1** (:class:`MyClass <name.space.MyClass>` instance)
 N/A N/A N/A self assertEqual expected actual N/A config N/A Config napoleon_use_param True N/A actual N/A str N/A NumpyDocstring docstring config N/A expected :param param1:
:type param1: :class:`MyClass <name.space.MyClass>` instance
 N/A N/A N/A self assertEqual expected actual N/A test_parameters_without_class_reference N/A N/A self N/A N/A N/A docstring Parameters
----------
param1 : MyClass instance

 N/A config N/A Config napoleon_use_param False N/A actual N/A str N/A NumpyDocstring docstring config N/A expected :Parameters: **param1** (*MyClass instance*)
 N/A N/A N/A self assertEqual expected actual N/A config N/A Config napoleon_use_param True N/A actual N/A str N/A NumpyDocstring N/A dedent docstring config N/A expected :param param1:
:type param1: MyClass instance
 N/A N/A N/A self assertEqual expected actual N/A test_see_also_refs N/A N/A self N/A N/A N/A docstring numpy.multivariate_normal(mean, cov, shape=None, spam=None)

See Also
--------
some, other, funcs
otherfunc : relationship

 N/A actual N/A str N/A NumpyDocstring docstring N/A expected numpy.multivariate_normal(mean, cov, shape=None, spam=None)

.. seealso::

   :obj:`some`, :obj:`other`, :obj:`funcs`
   
   :obj:`otherfunc`
       relationship
 N/A N/A N/A self assertEqual expected actual N/A docstring numpy.multivariate_normal(mean, cov, shape=None, spam=None)

See Also
--------
some, other, funcs
otherfunc : relationship

 N/A config N/A Config N/A app N/A N/A mock Mock N/A actual N/A str N/A NumpyDocstring docstring config app method N/A expected numpy.multivariate_normal(mean, cov, shape=None, spam=None)

.. seealso::

   :meth:`some`, :meth:`other`, :meth:`funcs`
   
   :meth:`otherfunc`
       relationship
 N/A N/A N/A self assertEqual expected actual N/A test_colon_in_return_type N/A N/A self N/A N/A N/A docstring 
Summary

Returns
-------
:py:class:`~my_mod.my_class`
    an instance of :py:class:`~my_mod.my_class`
 N/A expected 
Summary

:returns: an instance of :py:class:`~my_mod.my_class`
:rtype: :py:class:`~my_mod.my_class`
 N/A config N/A Config N/A app N/A N/A mock Mock N/A actual N/A str N/A NumpyDocstring docstring config app method N/A N/A N/A self assertEqual expected actual N/A test_underscore_in_attribute N/A N/A self N/A N/A N/A docstring 
Attributes
----------

arg_ : type
    some description
 N/A expected 
:ivar arg_: some description
:vartype arg_: type
 N/A config N/A Config napoleon_use_ivar True N/A app N/A N/A mock Mock N/A actual N/A str N/A NumpyDocstring docstring config app class N/A N/A N/A self assertEqual expected actual N/A test_raises_types N/A N/A self N/A N/A N/A docstrings N/A N/A 
Example Function

Raises
------
  RuntimeError

      A setting wasn't specified, or was invalid.
  ValueError

      Something something value error.

 
Example Function

:raises: * :exc:`RuntimeError` -- A setting wasn't specified, or was invalid.
         * :exc:`ValueError` -- Something something value error.
 N/A 
Example Function

Raises
------
InvalidDimensionsError

 
Example Function

:raises: :exc:`InvalidDimensionsError`
 N/A 
Example Function

Raises
------
Invalid Dimensions Error

 
Example Function

:raises: Invalid Dimensions Error
 N/A 
Example Function

Raises
------
Invalid Dimensions Error
    With description

 
Example Function

:raises: *Invalid Dimensions Error* -- With description
 N/A 
Example Function

Raises
------
InvalidDimensionsError
    If the dimensions couldn't be parsed.

 
Example Function

:raises: :exc:`InvalidDimensionsError` -- If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises
------
Invalid Dimensions Error
    If the dimensions couldn't be parsed.

 
Example Function

:raises: *Invalid Dimensions Error* -- If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises
------
If the dimensions couldn't be parsed.

 
Example Function

:raises: If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises
------
:class:`exc.InvalidDimensionsError`

 
Example Function

:raises: :class:`exc.InvalidDimensionsError`
 N/A 
Example Function

Raises
------
:class:`exc.InvalidDimensionsError`
    If the dimensions couldn't be parsed.

 
Example Function

:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't be parsed.
 N/A 
Example Function

Raises
------
:class:`exc.InvalidDimensionsError`
    If the dimensions couldn't be parsed,
    then a :class:`exc.InvalidDimensionsError` will be raised.

 
Example Function

:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't be parsed,
         then a :class:`exc.InvalidDimensionsError` will be raised.
 N/A 
Example Function

Raises
------
:class:`exc.InvalidDimensionsError`
    If the dimensions couldn't be parsed.
:class:`exc.InvalidArgumentsError`
    If the arguments are invalid.

 
Example Function

:raises: * :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't be parsed.
         * :class:`exc.InvalidArgumentsError` -- If the arguments are invalid.
 N/A 
Example Function

Raises
------
:class:`exc.InvalidDimensionsError`
:class:`exc.InvalidArgumentsError`

 
Example Function

:raises: * :class:`exc.InvalidDimensionsError`
         * :class:`exc.InvalidArgumentsError`
 N/A N/A docstring expected docstrings N/A N/A config N/A Config N/A app N/A N/A mock Mock N/A actual N/A str N/A NumpyDocstring docstring config app method N/A N/A N/A self assertEqual expected actual N/A test_xrefs_in_return_type N/A N/A self N/A N/A N/A docstring 
Example Function

Returns
-------
:class:`numpy.ndarray`
    A :math:`n \times 2` array containing
    a bunch of math items
 N/A expected 
Example Function

:returns: A :math:`n \times 2` array containing
          a bunch of math items
:rtype: :class:`numpy.ndarray`
 N/A config N/A Config N/A app N/A N/A mock Mock N/A actual N/A str N/A NumpyDocstring docstring config app method N/A N/A N/A self assertEqual expected actual N/A test_section_header_underline_length N/A N/A self N/A N/A N/A docstrings N/A N/A 
Summary line

Example
-
Multiline example
body

 
Summary line

Example
-
Multiline example
body
 N/A 
Summary line

Example
--
Multiline example
body

 
Summary line

.. rubric:: Example

Multiline example
body
 N/A 
Summary line

Example
-------
Multiline example
body

 
Summary line

.. rubric:: Example

Multiline example
body
 N/A 
Summary line

Example
------------
Multiline example
body

 
Summary line

.. rubric:: Example

Multiline example
body
 N/A N/A docstring expected docstrings N/A N/A actual N/A str N/A NumpyDocstring docstring N/A N/A N/A self assertEqual expected actual N/A test_list_in_parameter_description N/A N/A self N/A N/A N/A docstring One line summary.

Parameters
----------
no_list : int
one_bullet_empty : int
    *
one_bullet_single_line : int
    - first line
one_bullet_two_lines : int
    +   first line
        continued
two_bullets_single_line : int
    -  first line
    -  second line
two_bullets_two_lines : int
    * first line
      continued
    * second line
      continued
one_enumeration_single_line : int
    1.  first line
one_enumeration_two_lines : int
    1)   first line
         continued
two_enumerations_one_line : int
    (iii) first line
    (iv) second line
two_enumerations_two_lines : int
    a. first line
       continued
    b. second line
       continued
one_definition_one_line : int
    item 1
        first line
one_definition_two_lines : int
    item 1
        first line
        continued
two_definitions_one_line : int
    item 1
        first line
    item 2
        second line
two_definitions_two_lines : int
    item 1
        first line
        continued
    item 2
        second line
        continued
one_definition_blank_line : int
    item 1

        first line

        extra first line

two_definitions_blank_lines : int
    item 1

        first line

        extra first line

    item 2

        second line

        extra second line

definition_after_normal_text : int
    text line

    item 1
        first line
 N/A expected One line summary.

:param no_list:
:type no_list: int
:param one_bullet_empty:
                         *
:type one_bullet_empty: int
:param one_bullet_single_line:
                               - first line
:type one_bullet_single_line: int
:param one_bullet_two_lines:
                             +   first line
                                 continued
:type one_bullet_two_lines: int
:param two_bullets_single_line:
                                -  first line
                                -  second line
:type two_bullets_single_line: int
:param two_bullets_two_lines:
                              * first line
                                continued
                              * second line
                                continued
:type two_bullets_two_lines: int
:param one_enumeration_single_line:
                                    1.  first line
:type one_enumeration_single_line: int
:param one_enumeration_two_lines:
                                  1)   first line
                                       continued
:type one_enumeration_two_lines: int
:param two_enumerations_one_line:
                                  (iii) first line
                                  (iv) second line
:type two_enumerations_one_line: int
:param two_enumerations_two_lines:
                                   a. first line
                                      continued
                                   b. second line
                                      continued
:type two_enumerations_two_lines: int
:param one_definition_one_line:
                                item 1
                                    first line
:type one_definition_one_line: int
:param one_definition_two_lines:
                                 item 1
                                     first line
                                     continued
:type one_definition_two_lines: int
:param two_definitions_one_line:
                                 item 1
                                     first line
                                 item 2
                                     second line
:type two_definitions_one_line: int
:param two_definitions_two_lines:
                                  item 1
                                      first line
                                      continued
                                  item 2
                                      second line
                                      continued
:type two_definitions_two_lines: int
:param one_definition_blank_line:
                                  item 1

                                      first line

                                      extra first line
:type one_definition_blank_line: int
:param two_definitions_blank_lines:
                                    item 1

                                        first line

                                        extra first line

                                    item 2

                                        second line

                                        extra second line
:type two_definitions_blank_lines: int
:param definition_after_normal_text: text line

                                     item 1
                                         first line
:type definition_after_normal_text: int
 N/A config N/A Config napoleon_use_param True N/A actual N/A str N/A NumpyDocstring docstring config N/A N/A N/A self assertEqual expected actual N/A expected One line summary.

:Parameters: * **no_list** (*int*)
             * **one_bullet_empty** (*int*) --

               *
             * **one_bullet_single_line** (*int*) --

               - first line
             * **one_bullet_two_lines** (*int*) --

               +   first line
                   continued
             * **two_bullets_single_line** (*int*) --

               -  first line
               -  second line
             * **two_bullets_two_lines** (*int*) --

               * first line
                 continued
               * second line
                 continued
             * **one_enumeration_single_line** (*int*) --

               1.  first line
             * **one_enumeration_two_lines** (*int*) --

               1)   first line
                    continued
             * **two_enumerations_one_line** (*int*) --

               (iii) first line
               (iv) second line
             * **two_enumerations_two_lines** (*int*) --

               a. first line
                  continued
               b. second line
                  continued
             * **one_definition_one_line** (*int*) --

               item 1
                   first line
             * **one_definition_two_lines** (*int*) --

               item 1
                   first line
                   continued
             * **two_definitions_one_line** (*int*) --

               item 1
                   first line
               item 2
                   second line
             * **two_definitions_two_lines** (*int*) --

               item 1
                   first line
                   continued
               item 2
                   second line
                   continued
             * **one_definition_blank_line** (*int*) --

               item 1

                   first line

                   extra first line
             * **two_definitions_blank_lines** (*int*) --

               item 1

                   first line

                   extra first line

               item 2

                   second line

                   extra second line
             * **definition_after_normal_text** (*int*) -- text line

               item 1
                   first line
 N/A config N/A Config napoleon_use_param False N/A actual N/A str N/A NumpyDocstring docstring config N/A N/A N/A self assertEqual expected actual N/A test_keywords_with_types N/A N/A self N/A N/A N/A docstring Do as you please

Keyword Args:
    gotham_is_yours (None): shall interfere.
 N/A actual N/A str N/A GoogleDocstring docstring N/A expected Do as you please

:keyword gotham_is_yours: shall interfere.
:kwtype gotham_is_yours: None
 N/A N/A N/A self assertEqual expected actual N/A N/A