summaryrefslogtreecommitdiff
path: root/doc/source/modules/io/spech5.rst
diff options
context:
space:
mode:
authorPicca Frédéric-Emmanuel <picca@debian.org>2017-10-07 07:59:01 +0200
committerPicca Frédéric-Emmanuel <picca@debian.org>2017-10-07 07:59:01 +0200
commitbfa4dba15485b4192f8bbe13345e9658c97ecf76 (patch)
treefb9c6e5860881fbde902f7cbdbd41dc4a3a9fb5d /doc/source/modules/io/spech5.rst
parentf7bdc2acff3c13a6d632c28c4569690ab106eed7 (diff)
New upstream version 0.6.0+dfsg
Diffstat (limited to 'doc/source/modules/io/spech5.rst')
-rw-r--r--doc/source/modules/io/spech5.rst36
1 files changed, 35 insertions, 1 deletions
diff --git a/doc/source/modules/io/spech5.rst b/doc/source/modules/io/spech5.rst
index 143d3bb..61e0083 100644
--- a/doc/source/modules/io/spech5.rst
+++ b/doc/source/modules/io/spech5.rst
@@ -5,7 +5,41 @@
-----------------------------------------
.. automodule:: silx.io.spech5
+
+
+Classes
++++++++
+
+- :class:`SpecH5`
+- :class:`SpecH5Group`
+- :class:`SpecH5Dataset`
+
+.. autoclass:: SpecH5
+ :members:
+ :show-inheritance:
+ :undoc-members:
+ :inherited-members: name, basename, attrs, h5py_class, parent,
+ get, keys, values, items,
+ :special-members: __getitem__, __len__, __contains__, __enter__, __exit__, __iter__
+ :exclude-members: add_node
+
+.. autoclass:: SpecH5Group
+ :show-inheritance:
+
+.. autoclass:: silx.io.commonh5.Group
+ :show-inheritance:
+ :undoc-members:
+ :members: name, basename, file, attrs, h5py_class, parent,
+ get, keys, values, items, visit, visititems
+ :special-members: __getitem__, __len__, __contains__, __iter__
+ :exclude-members: add_node
+
+.. autoclass:: SpecH5Dataset
+ :show-inheritance:
+
+.. autoclass:: SpecH5NodeDataset
:members:
:show-inheritance:
:undoc-members:
- :special-members: __getitem__, __len__, __contains__
+ :inherited-members:
+ :special-members: __getitem__, __len__, __iter__, __getattr__