Skip to content

Commit

Permalink
fix larray-project#301 : updated api.rst to display also instance att…
Browse files Browse the repository at this point in the history
…ributes (not possible with Sphinx)
  • Loading branch information
alixdamman committed Jun 12, 2017
1 parent 7ce9ada commit d6c6b91
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions doc/source/api.rst
Expand Up @@ -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
Expand Down Expand Up @@ -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/

Expand Down

0 comments on commit d6c6b91

Please sign in to comment.