Adding upstream version 0.19.2.upstream/0.19.2upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 24 insertions, 0 deletions

diff --git a/doc/python/orcus/gnumeric/index.rst b/doc/python/orcus/gnumeric/index.rst
new file mode 100644
index 0000000..a3ab2cc
--- /dev/null
+++ b/doc/python/orcus/gnumeric/index.rst
@@ -0,0 +1,24 @@
+
+orcus.gnumeric
+==============
+
+.. py:function:: orcus.gnumeric.read
+
+   Read an Gnumeric file from a specified file path and create a
+   :py:class:`orcus.Document` instance object.
+
+   :param stream: file object containing byte streams.
+   :param bool recalc: optional parameter specifying whether or not to recalculate
+       the formula cells on load. Defaults to ``False``.
+   :param str error_policy: optional parameter indicating what to do when
+       encountering formula cells with invalid formula expressions. The value
+       must be either ``fail`` or ``skip``.  Defaults to ``fail``.
+   :rtype: :py:class:`orcus.Document`
+   :return: document instance object that stores the content of the file.
+
+   Example::
+
+      from orcus import gnumeric
+
+      with open("path/to/file.gnumeric", "rb") as f:
+          doc = gnumeric.read(f, recalc=True, error_policy="fail")