Import Upstream version 0.5.0+dfsg

10 files changed, 181 insertions, 0 deletions

diff --git a/doc/source/modules/io/configdict.rst b/doc/source/modules/io/configdict.rst
new file mode 100644
index 0000000..bc0cdb7
--- /dev/null
+++ b/doc/source/modules/io/configdict.rst
@@ -0,0 +1,8 @@
+
+.. currentmodule:: silx.io
+    
+:mod:`configdict`: Configuration files I/O
+-------------------------------------------
+
+.. automodule:: silx.io.configdict
+    :members:
diff --git a/doc/source/modules/io/dictdump.rst b/doc/source/modules/io/dictdump.rst
new file mode 100644
index 0000000..1778d78
--- /dev/null
+++ b/doc/source/modules/io/dictdump.rst
@@ -0,0 +1,8 @@
+
+.. currentmodule:: silx.io
+
+:mod:`dictdump`: Dumping and loading dictionaries
+--------------------------------------------------
+
+.. automodule:: silx.io.dictdump
+    :members:
diff --git a/doc/source/modules/io/index.rst b/doc/source/modules/io/index.rst
new file mode 100644
index 0000000..1538a74
--- /dev/null
+++ b/doc/source/modules/io/index.rst
@@ -0,0 +1,25 @@
+
+.. py:module:: silx.io
+
+:mod:`silx.io`: Input-output
+============================
+
+
+.. toctree::
+   :maxdepth: 1
+   
+   configdict.rst
+   dictdump.rst
+   nxdata.rst
+   octaveh5.rst
+   specfile.rst
+   specfilewrapper.rst
+   spech5.rst
+   spectoh5.rst
+   utils.rst
+
+Top-level functions
+-------------------
+
+.. autofunction:: silx.io.open
+.. autofunction:: silx.io.save1D
diff --git a/doc/source/modules/io/nxdata.rst b/doc/source/modules/io/nxdata.rst
new file mode 100644
index 0000000..7940270
--- /dev/null
+++ b/doc/source/modules/io/nxdata.rst
@@ -0,0 +1,8 @@
+
+.. currentmodule:: silx.io
+
+:mod:`nxdata`: NXdata group parsing
+------------------------------------
+
+.. automodule:: silx.io.nxdata
+    :members:
diff --git a/doc/source/modules/io/octaveh5.rst b/doc/source/modules/io/octaveh5.rst
new file mode 100644
index 0000000..982f346
--- /dev/null
+++ b/doc/source/modules/io/octaveh5.rst
@@ -0,0 +1,10 @@
+
+.. currentmodule:: silx.io
+
+:mod:`octaveh5`: Octave HDF5 compatibility
+-------------------------------------------
+
+.. automodule:: silx.io.octaveh5
+    :members:
+    :show-inheritance:
+    :undoc-members:
diff --git a/doc/source/modules/io/specfile.rst b/doc/source/modules/io/specfile.rst
new file mode 100644
index 0000000..a937ca8
--- /dev/null
+++ b/doc/source/modules/io/specfile.rst
@@ -0,0 +1,83 @@
+
+.. currentmodule:: silx.io
+
+:mod:`specfile`: Reading SpecFile
+----------------------------------
+
+.. automodule:: silx.io.specfile
+    :members:
+    :undoc-members:
+
+.. autoclass:: silx.io.specfile.SpecFile
+    :members:
+    :undoc-members:
+
+    .. automethod:: __len__
+
+    .. automethod:: __iter__
+
+    .. automethod:: __getitem__
+
+.. autoclass:: silx.io.specfile.Scan
+    :members:
+    :undoc-members:
+
+.. autoclass:: silx.io.specfile.MCA
+    :members:
+    :undoc-members:
+
+    .. automethod:: __len__
+
+    .. automethod:: __iter__
+
+    .. automethod:: __getitem__
+
+.. autoclass:: silx.io.specfile.SfError
+
+.. autoclass:: silx.io.specfile.SfErrMemoryAlloc
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrFileOpen
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrFileClose
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrFileRead
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrFileWrite
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrLineNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrScanNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrHeaderNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrLabelNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrMotorNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrPositionNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrLineEmpty
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrUserNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrColNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfErrMcaNotFound
+    :show-inheritance:
+
+.. autoclass:: silx.io.specfile.SfNoMcaError
+    :show-inheritance:
diff --git a/doc/source/modules/io/specfilewrapper.rst b/doc/source/modules/io/specfilewrapper.rst
new file mode 100644
index 0000000..3cd8915
--- /dev/null
+++ b/doc/source/modules/io/specfilewrapper.rst
@@ -0,0 +1,12 @@
+
+.. currentmodule:: silx.io
+
+:mod:`specfilewrapper`: Reading SpecFile (old API)
+---------------------------------------------------
+
+.. automodule:: silx.io.specfilewrapper
+    :members:
+    :show-inheritance:
+    :undoc-members:
+    :special-members: __getitem__
+
diff --git a/doc/source/modules/io/spech5.rst b/doc/source/modules/io/spech5.rst
new file mode 100644
index 0000000..143d3bb
--- /dev/null
+++ b/doc/source/modules/io/spech5.rst
@@ -0,0 +1,11 @@
+
+.. currentmodule:: silx.io
+
+:mod:`spech5`: h5py-like API to SpecFile
+-----------------------------------------
+
+.. automodule:: silx.io.spech5
+    :members:
+    :show-inheritance:
+    :undoc-members:
+    :special-members: __getitem__, __len__, __contains__
diff --git a/doc/source/modules/io/spectoh5.rst b/doc/source/modules/io/spectoh5.rst
new file mode 100644
index 0000000..05fc768
--- /dev/null
+++ b/doc/source/modules/io/spectoh5.rst
@@ -0,0 +1,8 @@
+
+.. currentmodule:: silx.io
+
+:mod:`spectoh5`: SpecFile to HDF5 conversion
+---------------------------------------------
+
+.. automodule:: silx.io.spectoh5
+    :members: write_spec_to_h5, convert
diff --git a/doc/source/modules/io/utils.rst b/doc/source/modules/io/utils.rst
new file mode 100644
index 0000000..f243bcb
--- /dev/null
+++ b/doc/source/modules/io/utils.rst
@@ -0,0 +1,8 @@
+
+.. currentmodule:: silx.io
+
+:mod:`utils`: I/O utilities
+-----------------------------
+
+.. automodule:: silx.io.utils
+    :members: