summaryrefslogtreecommitdiffstats
path: root/doc/python/orcus/document.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/python/orcus/document.rst')
-rw-r--r--doc/python/orcus/document.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/python/orcus/document.rst b/doc/python/orcus/document.rst
new file mode 100644
index 0000000..d4b6fc5
--- /dev/null
+++ b/doc/python/orcus/document.rst
@@ -0,0 +1,21 @@
+
+Document
+========
+
+.. py:class:: orcus.Document
+
+ An instance of this class represents a document model. A document consists
+ of multiple sheet objects.
+
+ .. py:attribute:: sheets
+
+ Read-only attribute that stores a tuple of :py:class:`.Sheet` instance
+ objects.
+
+ .. py:function:: get_named_expressions
+
+ Get a named expressions iterator.
+
+ :rtype: :obj:`.NamedExpressions`
+ :return: named expression object.
+