From d6c6b9108f6dd25d717936c5c01a87747c20aecf Mon Sep 17 00:00:00 2001 From: Alix Damman Date: Mon, 12 Jun 2017 11:13:05 +0200 Subject: [PATCH] fix #301 : updated api.rst to display also instance attributes (not possible with Sphinx) --- doc/source/api.rst | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/doc/source/api.rst b/doc/source/api.rst index 2c1a79002..0b3d46d11 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -13,11 +13,23 @@ Axis Axis +Exploring +--------- + +=========================== ============================================================== +Axis.name Name of the axis. None in the case of an anonymous axis +--------------------------- -------------------------------------------------------------- +:attr:`Axis.labels` List of labels +--------------------------- -------------------------------------------------------------- +:attr:`Axis.labels_summary` Short representation of the labels. +=========================== ============================================================== + +Copying +------- + .. autosummary:: :toctree: _generated/ - Axis.labels - Axis.labels_summary Axis.copy Searching @@ -227,6 +239,14 @@ Copying Inspecting ---------- +=================== ============================================================== +LArray.data Data of the array (Numpy ndarray) +------------------- -------------------------------------------------------------- +LArray.axes Axes of the array (AxisCollection) +------------------- -------------------------------------------------------------- +LArray.title Title of the array (str) +=================== ============================================================== + .. autosummary:: :toctree: _generated/