From a402f3bd3578cbd643dc29b057820d05cebacd4a 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 ++++++++++++++++++++++-- larray/core/axis.py | 2 +- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/doc/source/api.rst b/doc/source/api.rst index 2c1a79002..2690d297b 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` Labels of the axis. +--------------------------- -------------------------------------------------------------- +: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/ diff --git a/larray/core/axis.py b/larray/core/axis.py index 412039683..4de5586f1 100644 --- a/larray/core/axis.py +++ b/larray/core/axis.py @@ -177,7 +177,7 @@ def i(self): @property def labels(self): """ - List of labels. + labels of the axis. """ return self._labels