]> git.notmuchmail.org Git - notmuch/blobdiff - bindings/python/docs/source/filesystem.rst
python: split the documentation
[notmuch] / bindings / python / docs / source / filesystem.rst
diff --git a/bindings/python/docs/source/filesystem.rst b/bindings/python/docs/source/filesystem.rst
new file mode 100644 (file)
index 0000000..685dc4d
--- /dev/null
@@ -0,0 +1,30 @@
+Files and directories
+=====================
+
+.. currentmodule:: notmuch
+
+:class:`Filenames` -- An iterator over filenames
+------------------------------------------------
+
+.. autoclass:: Filenames
+
+   .. automethod:: Filenames.__len__
+
+   .. automethod:: Filenames.as_generator
+
+:class:`Directoy` -- A directory entry in the database
+------------------------------------------------------
+
+.. autoclass:: Directory
+
+   .. automethod:: Directory.get_child_files
+
+   .. automethod:: Directory.get_child_directories
+
+   .. automethod:: Directory.get_mtime
+
+   .. automethod:: Directory.set_mtime
+
+   .. autoattribute:: Directory.mtime
+
+   .. autoattribute:: Directory.path