Merge pull request #4515 from hvy/bp-4495-document-arithmetic-specials

[backport] document arithmetic special functions
chainer · Mar 22, 2018 · 3230942 · 3230942
2 parents 50255f2 + 6002fc4
commit 3230942
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst
@@ -38,6 +38,16 @@
    .. automethod:: {{ item }}
 {% endif %}
 {%- endfor %}
+
+   ..
+      Special (arithmetic) methods
+
+{% for item in ('__neg__', '__abs__', '__add__', '__radd__', '__sub__', '__rsub__', '__mul__', '__rmul__', '__div__', '__truediv__', '__rdiv__', '__rtruediv__', '__floordiv__', '__rfloordiv__', '__pow__', '__rpow__', '__matmul__', '__rmatmul__') %}
+{% if item in all_methods %}
+   .. automethod:: {{ item }}
+{% endif %}
+{%- endfor %}
+
 {% endblock %}
 
    ..