alphalens icon indicating copy to clipboard operation
alphalens copied to clipboard

Compilation of docs warnings

Open twiecki opened this issue 6 years ago • 0 comments

.. autosummary::
   :toctree:

   close
   next_cell
   next_row
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_event_returns_tear_sheet_api_change_warning:5: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_event_returns_tear_sheet_api_change_warning:11: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_full_tear_sheet_api_change_warning:5: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_full_tear_sheet_api_change_warning:10: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_information_tear_sheet_api_change_warning:5: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_information_tear_sheet_api_change_warning:9: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_returns_tear_sheet_api_change_warning:5: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/tears.py:docstring of alphalens.tears.create_returns_tear_sheet_api_change_warning:9: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/performance.py:docstring of alphalens.performance.average_cumulative_return_by_quantile:59: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/performance.py:docstring of alphalens.performance.cumulative_returns:11: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:17: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:52: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:132: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:132: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:138: WARNING: Bullet list ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:139: WARNING: Unexpected section title or transition.

-------------------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:140: WARNING: Inline substitution_reference start-string without end-string.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:141: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:141: WARNING: Unexpected section title or transition.

-------------------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:143: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:143: WARNING: Unexpected section title or transition.

-------------------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:145: WARNING: Line block ends without a blank line.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:145: WARNING: Unexpected section title or transition.

--------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:147: WARNING: Line block ends without a blank line.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:147: WARNING: Unexpected section title or transition.

--------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:148: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:149: WARNING: Unexpected section title or transition.

--------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:151: WARNING: Line block ends without a blank line.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:151: WARNING: Unexpected section title or transition.

--------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:153: WARNING: Line block ends without a blank line.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:153: WARNING: Unexpected section title or transition.

--------------------------------------------------------
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns_api_change_warning:5: WARNING: Unexpected indentation.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns_api_change_warning:16: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:0: WARNING: Undefined substitution referenced: "-0.02".
/Users/twiecki/working/projects/quant/alphalens/alphalens/utils.py:docstring of alphalens.utils.get_clean_factor_and_forward_returns:0: WARNING: Undefined substitution referenced: "-0.03".
/Users/twiecki/working/projects/quant/alphalens/docs/source/alphalens.tests.rst:2: WARNING: Title underline too short.

alphalens.tests package
=====================
/Users/twiecki/working/projects/quant/alphalens/docs/source/alphalens.tests.rst:8: WARNING: Title underline too short.

alphalens.tests.test_performance module
-------------------------------------
/Users/twiecki/working/projects/quant/alphalens/docs/source/alphalens.tests.rst:8: WARNING: Title underline too short.

alphalens.tests.test_performance module
-------------------------------------
/Users/twiecki/working/projects/quant/alphalens/docs/source/alphalens.tests.rst:10: WARNING: autodoc: failed to import module 'alphalens.tests.test_performance'; the following exception was raised:
Traceback (most recent call last):
  File "/Users/twiecki/anaconda/lib/python3.6/site-packages/sphinx/ext/autodoc.py", line 658, in import_object
    __import__(self.modname)
  File "/Users/twiecki/working/projects/quant/alphalens/alphalens/tests/test_performance.py", line 18, in <module>
    from parameterized import parameterized
ModuleNotFoundError: No module named 'parameterized'
/Users/twiecki/working/projects/quant/alphalens/docs/source/alphalens.tests.rst:16: WARNING: Title underline too short.

alphalens.tests.test_utils module
-------------------------------
/Users/twiecki/working/projects/quant/alphalens/docs/source/alphalens.tests.rst:16: WARNING: Title underline too short.

alphalens.tests.test_utils module
-------------------------------
/Users/twiecki/working/projects/quant/alphalens/docs/source/alphalens.tests.rst:18: WARNING: autodoc: failed to import module 'alphalens.tests.test_utils'; the following exception was raised:
Traceback (most recent call last):
  File "/Users/twiecki/anaconda/lib/python3.6/site-packages/sphinx/ext/autodoc.py", line 658, in import_object
    __import__(self.modname)
  File "/Users/twiecki/working/projects/quant/alphalens/alphalens/tests/test_utils.py", line 18, in <module>
    from parameterized import parameterized
ModuleNotFoundError: No module named 'parameterized'
/Users/twiecki/working/projects/quant/alphalens/docs/source/modules.rst:2: WARNING: Title underline too short.

alphalens

twiecki avatar Jan 31 '18 17:01 twiecki