diff options
Diffstat (limited to 'doc/source/modules/io')
| -rw-r--r-- | doc/source/modules/io/fioh5.rst | 35 | ||||
| -rw-r--r-- | doc/source/modules/io/index.rst | 1 |
2 files changed, 36 insertions, 0 deletions
diff --git a/doc/source/modules/io/fioh5.rst b/doc/source/modules/io/fioh5.rst new file mode 100644 index 0000000..c901878 --- /dev/null +++ b/doc/source/modules/io/fioh5.rst @@ -0,0 +1,35 @@ + +.. currentmodule:: silx.io + +:mod:`fioh5`: h5py-like API to FIO file +---------------------------------------- + +.. automodule:: silx.io.fioh5 + + +Classes ++++++++ + +- :class:`FioH5` +- :class:`FioFile` + +.. autoclass:: FioH5 + :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:: FioFile + +.. 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 + +.. autofunction:: is_fiofile
\ No newline at end of file diff --git a/doc/source/modules/io/index.rst b/doc/source/modules/io/index.rst index 581f763..a511bef 100644 --- a/doc/source/modules/io/index.rst +++ b/doc/source/modules/io/index.rst @@ -16,6 +16,7 @@ specfile.rst specfilewrapper.rst spech5.rst + fioh5.rst url.rst utils.rst h5py_utils.rst |