From d50171d1cc575a41bf620c55853ade65d0edfad8 Mon Sep 17 00:00:00 2001
From: Justus Winter <4winter@informatik.uni-hamburg.de>
Date: Fri, 24 Feb 2012 01:34:15 +0100
Subject: python: split the documentation

Move each classes documentation into its own file and thus into its
own page in the generated documentation.

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
---
 bindings/python/docs/source/filesystem.rst | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 bindings/python/docs/source/filesystem.rst

(limited to '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
index 0000000..685dc4d
--- /dev/null
+++ b/bindings/python/docs/source/filesystem.rst
@@ -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
-- 
cgit v1.2.3


From 60e512d84fd04291f552503f139ae6893b25018b Mon Sep 17 00:00:00 2001
From: Justus Winter <4winter@informatik.uni-hamburg.de>
Date: Mon, 30 Apr 2012 18:32:32 +0200
Subject: python: fix the documentation

Remove the reference to Filenames.as_generator in the sphinx
documentation.

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
---
 bindings/python/docs/source/filesystem.rst | 2 --
 1 file changed, 2 deletions(-)

(limited to 'bindings/python/docs/source/filesystem.rst')

diff --git a/bindings/python/docs/source/filesystem.rst b/bindings/python/docs/source/filesystem.rst
index 685dc4d..4eb7810 100644
--- a/bindings/python/docs/source/filesystem.rst
+++ b/bindings/python/docs/source/filesystem.rst
@@ -10,8 +10,6 @@ Files and directories
 
    .. automethod:: Filenames.__len__
 
-   .. automethod:: Filenames.as_generator
-
 :class:`Directoy` -- A directory entry in the database
 ------------------------------------------------------
 
-- 
cgit v1.2.3