summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorrfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f>2010-12-28 07:16:13 +0000
committerrfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f>2010-12-28 07:16:13 +0000
commitace9837b37bc4046c2ac6b1c171b1d7b85e2707e (patch)
treeee9acd97264fc8d7827101321aace72602e472e6 /docs
parent3ed0384d85a39d74a31c7e34c16620efb42d857e (diff)
downloadpyfilesystem-ace9837b37bc4046c2ac6b1c171b1d7b85e2707e.tar.gz
whoops, adding some doc files I forgot to commit
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@585 67cdc799-7952-0410-af00-57a81ceafa0f
Diffstat (limited to 'docs')
-rw-r--r--docs/filelike.rst2
-rw-r--r--docs/remote.rst2
-rw-r--r--docs/utilities.rst23
3 files changed, 27 insertions, 0 deletions
diff --git a/docs/filelike.rst b/docs/filelike.rst
new file mode 100644
index 0000000..e2313bd
--- /dev/null
+++ b/docs/filelike.rst
@@ -0,0 +1,2 @@
+.. automodule:: fs.filelike
+ :members:
diff --git a/docs/remote.rst b/docs/remote.rst
new file mode 100644
index 0000000..2cc65cf
--- /dev/null
+++ b/docs/remote.rst
@@ -0,0 +1,2 @@
+.. automodule:: fs.remote
+ :members:
diff --git a/docs/utilities.rst b/docs/utilities.rst
new file mode 100644
index 0000000..3097729
--- /dev/null
+++ b/docs/utilities.rst
@@ -0,0 +1,23 @@
+Utility Modules
+===============
+
+PyFilesystem also contains some miscellaneous utility modules to make writing
+new FS implementations easier.
+
+
+fs.path
+-------
+Contains many utility functions for manipulating filesystem paths. See :mod:`fs.path`.
+
+fs.errors
+---------
+Contains all the standard error classes used by PyFilesystem, along with some useful error-handling decorators. See :mod:`fs.errors`.
+
+fs.filelike
+-----------
+Takes care of a lot of the groundwork for implementing and manipulating objects that support Python's standard "file-like" interface. See :mod:`fs.filelike`.
+
+fs.remote
+---------
+Contains useful functions and classes for implementing remote filesystems. See :mod:`fs.remote`.
+