Back to Turicreate

Class

src/python/doc/source/_templates/autosummary/class.rst

6.4.11.5 KB
Original Source

:orphan:

.. This template is borrowed from Pandas documentation: https://github.com/pydata/pandas/blob/master/doc/_templates/autosummary/class.rst

{% extends "!autosummary/class.rst" %}

{% block methods %} {% if methods %}

.. rubric:: Methods

.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. .. autosummary:: :toctree: {% for item in all_methods %} {%- if not (item.startswith('_') or item in ['call'] or (name == 'SArray' and item in ['add', 'mul', 'sub', 'div', 'radd', 'rmul', 'rsub', 'rdiv', 'and', 'or', 'gt', 'lt', 'eq', 'ne', 'ge', 'le', ]) or (name == 'SFrame' and item in [ 'delitem', 'format', 'getitem', 'init', 'iter', 'len', 'new', 'nonzero', 'reduce', 'reduce_ex', 'repr', 'setitem', 'sizeof', 'str', 'subclasshook', ])) %} {{ name }}.{{ item }} {%- endif -%} {%- endfor %}

{% endif %} {% endblock %}

{% block attributes %} {% if attributes %}

.. rubric:: Attributes

.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. .. autosummary:: :toctree: :nosignature {% for item in all_attributes %} {%- if not item.startswith('_') %} {{ name }}.{{ item }} {%- endif -%} {%- endfor %}

{% endif %} {% endblock %}