initializer.InitDesc docs error

[aaronmarkham]

Description

Sphinx throws an error on initializer.InitDesc.

Error

/home/ubuntu/incubator-mxnet/python/mxnet/initializer.py:docstring of mxnet.initializer.InitDesc:4: SEVERE: Unexpected section title.

[aaronmarkham]

It also throws this error:

/home/ubuntu/incubator-mxnet/python/mxnet/initializer.py:docstring of mxnet.initializer.Initializer.set_verbosity:5: ERROR: Undefined substitution referenced: "x".

[andrewfayres]

@mxnet-label-bot add [doc]

[aaronmarkham]

Notes on ERROR: Undefined substitution referenced:

Undefined substitution reference error

ERROR: Undefined substitution referenced: "x".

In some math examples, people will use |var| to express the absolute value of something. The usage of pipes around a name is special to Sphinx and triggers a substitution of that value for something that is defined in the doc later. Switching to actual code or escaping the math can fix this.

            absolute value str((-|--x--|-/size(x)).asscalar()).
            absolute value str((*abs(x**)*/size(x)).asscalar()).

An inline literal would work too. Switch the following pseudo-code that triggers the problem:

            absolute value str((|x|/size(x)).asscalar()).

To an inline literal with the double backticks:

            ``absolute value str((|x|/size(x)).asscalar())``

Or a regular block would work:

"""
Some description ::

    absolute value str((|x|/size(x)).asscalar())

Where you made sure there were line breaks before and after the indented code block 

Or a code-block should work:

    .. code-block:: python

       absolute value str((|x|/size(x)).asscalar())