This repository was archived by the owner on Nov 17, 2023. It is now read-only.
This repository was archived by the owner on Nov 17, 2023. It is now read-only.
RecordIO API docs errors #13008
Description
Description
Sphinx throws several errors when generating the RecordIO API docs.
Error
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO:4: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO:4: SEVERE: Unexpected section title.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.reset:6: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.reset:6: SEVERE: Unexpected section title.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.write:4: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.write:4: SEVERE: Unexpected section title.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.read:4: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.read:4: SEVERE: Unexpected section title.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO:4: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO:4: SEVERE: Unexpected section title.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.tell:4: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.tell:4: SEVERE: Unexpected section title.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.read_idx:4: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.read_idx:4: SEVERE: Unexpected section title.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.write_idx:4: WARNING: Title underline too short.
Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.write_idx:4: SEVERE: Unexpected section title.