Improve Sphinx documentation

doc/conversion.rst

@@ -0,0 +1,13 @@
+=============
+Conversion from old release versions
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+Release version 1.0.0 introduced some changes to the file format (see `Release notes
+<https://github.com/INM-6/h5py_wrapper/releases>`_).
+
+.. literalinclude:: ../convert_h5file
+   :start-after: """
+   :end-before: """

doc/index.rst

@@ -22,6 +22,22 @@ API reference
 
    api_reference
 
+
+Supported data types
+====================
+.. toctree::
+   :maxdepth: 2
+
+   supported_datatypes
+
+Conversion from old releases
+============================
+.. toctree::
+   :maxdepth: 2
+
+   conversion
+
+
 Indices and tables
 ==================
 

doc/supported_datatypes.rst

@@ -0,0 +1,47 @@
+====================
+Supported data types
+====================
+
+.. toctree::
+   :maxdepth: 2
+
+
+The wrapper stores the original data types of values of the dictionary in the produced hdf5 file.
+The following data types are supported:
+
+* float
+
+* int
+
+* str
+
+* tuple
+
+* numpy.array
+
+* list
+
+* bool
+
+* quantities.Quantity (see https://pypi.python.org/pypi/quantities)
+
+* Lists, tuples and numpy.arrays up to arbitrary depths if all dimensions are uniform, e.g.
+
+  .. code-block:: python
+		  
+		  l = numpy.ones((3,3,3))
+
+* Lists and tuples are required to contain the contain equal data types across one dimension. For instance, this raises an error
+
+
+  .. code-block:: python
+		
+		l = [[1,2], 'a']
+
+
+
+* Lists, tuples and numpy.arrays with unequal dimensions with maximal depth 1.
+
+  .. code-block:: python
+		
+		l = [[1,2], [1]]