diff options
Diffstat (limited to 'doc/source/modules/io')
-rw-r--r-- | doc/source/modules/io/convert.rst | 8 | ||||
-rw-r--r-- | doc/source/modules/io/index.rst | 7 | ||||
-rw-r--r-- | doc/source/modules/io/spech5.rst | 36 | ||||
-rw-r--r-- | doc/source/modules/io/spectoh5.rst | 8 |
4 files changed, 49 insertions, 10 deletions
diff --git a/doc/source/modules/io/convert.rst b/doc/source/modules/io/convert.rst new file mode 100644 index 0000000..4d3abdc --- /dev/null +++ b/doc/source/modules/io/convert.rst @@ -0,0 +1,8 @@ + +.. currentmodule:: silx.io + +:mod:`convert`: HDF5 conversion +------------------------------- + +.. automodule:: silx.io.convert + :members: write_to_h5, convert diff --git a/doc/source/modules/io/index.rst b/doc/source/modules/io/index.rst index 1538a74..815a094 100644 --- a/doc/source/modules/io/index.rst +++ b/doc/source/modules/io/index.rst @@ -9,13 +9,13 @@ :maxdepth: 1 configdict.rst + convert.rst dictdump.rst nxdata.rst octaveh5.rst specfile.rst specfilewrapper.rst spech5.rst - spectoh5.rst utils.rst Top-level functions @@ -23,3 +23,8 @@ Top-level functions .. autofunction:: silx.io.open .. autofunction:: silx.io.save1D + +.. autofunction:: silx.io.is_dataset +.. autofunction:: silx.io.is_group +.. autofunction:: silx.io.is_file +.. autofunction:: silx.io.is_softlink 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__ diff --git a/doc/source/modules/io/spectoh5.rst b/doc/source/modules/io/spectoh5.rst deleted file mode 100644 index 05fc768..0000000 --- a/doc/source/modules/io/spectoh5.rst +++ /dev/null @@ -1,8 +0,0 @@ - -.. currentmodule:: silx.io - -:mod:`spectoh5`: SpecFile to HDF5 conversion ---------------------------------------------- - -.. automodule:: silx.io.spectoh5 - :members: write_spec_to_h5, convert |