diff options
author | Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-02-24 01:34:15 +0100 |
---|---|---|
committer | Justus Winter <4winter@informatik.uni-hamburg.de> | 2012-02-24 01:55:33 +0100 |
commit | d50171d1cc575a41bf620c55853ade65d0edfad8 (patch) | |
tree | 495247d3b0f2ec1af08211330e6a9e8f8b428c7f /bindings/python/docs/source/filesystem.rst | |
parent | 594dbb62432bd7f92d1e121145b80628eb8aad2a (diff) |
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>
Diffstat (limited to 'bindings/python/docs/source/filesystem.rst')
-rw-r--r-- | bindings/python/docs/source/filesystem.rst | 30 |
1 files changed, 30 insertions, 0 deletions
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 |