diff options
| author | rfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f> | 2010-08-04 13:23:05 +0000 |
|---|---|---|
| committer | rfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f> | 2010-08-04 13:23:05 +0000 |
| commit | 03524a3088269ecefeb2ea1a7a8ce0cb5ecba835 (patch) | |
| tree | d818c2736937aefd2d8c7efdcbfea2bbeafadd8d /docs | |
| parent | 4b539ace0a28b64737dd3f7d9ba9af779ba21d94 (diff) | |
| download | pyfilesystem-03524a3088269ecefeb2ea1a7a8ce0cb5ecba835.tar.gz | |
add docs for latest additions
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@395 67cdc799-7952-0410-af00-57a81ceafa0f
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contrib.rst | 17 | ||||
| -rw-r--r-- | docs/contrib/bigfs.rst | 2 | ||||
| -rw-r--r-- | docs/contrib/davfs.rst | 2 | ||||
| -rw-r--r-- | docs/contrib/index.rst | 11 | ||||
| -rw-r--r-- | docs/expose.rst | 4 | ||||
| -rw-r--r-- | docs/expose/dokan.rst | 2 | ||||
| -rw-r--r-- | docs/expose/index.rst | 3 | ||||
| -rw-r--r-- | docs/index.rst | 2 |
8 files changed, 42 insertions, 1 deletions
diff --git a/docs/contrib.rst b/docs/contrib.rst new file mode 100644 index 0000000..f17e399 --- /dev/null +++ b/docs/contrib.rst @@ -0,0 +1,17 @@ +3rd-Party Filesystems +===================== + +This page lists filesystem implementations that have been contributed by +third parties. They may be less well tested than those found in the main +module namespace. + +DAV (WebDAV Protocol) +---------------------------- +An interface to WebDAV file servers. See :mod:`fs.contrib.davfs` + + +BIG (BIG Archive File Format) +----------------------------- +A read-only interface to the BIG archive file format used in some EA games titles (e.g. Command & Conquery 4). See :mod:`fs.contrib.bigfs` + + diff --git a/docs/contrib/bigfs.rst b/docs/contrib/bigfs.rst new file mode 100644 index 0000000..57e5ab1 --- /dev/null +++ b/docs/contrib/bigfs.rst @@ -0,0 +1,2 @@ +.. automodule:: fs.contrib.bigfs + :members: diff --git a/docs/contrib/davfs.rst b/docs/contrib/davfs.rst new file mode 100644 index 0000000..9d9f5ac --- /dev/null +++ b/docs/contrib/davfs.rst @@ -0,0 +1,2 @@ +.. automodule:: fs.contrib.davfs + :members: diff --git a/docs/contrib/index.rst b/docs/contrib/index.rst new file mode 100644 index 0000000..ce93302 --- /dev/null +++ b/docs/contrib/index.rst @@ -0,0 +1,11 @@ +fs.contrib +========= + +The ``fs.contrib`` module contains a number of filesystem implementations provided by third parties. + +.. toctree:: + :maxdepth: 3 + + davfs.rst + bigfs.rst + diff --git a/docs/expose.rst b/docs/expose.rst index 650c457..e4ee403 100644 --- a/docs/expose.rst +++ b/docs/expose.rst @@ -8,6 +8,10 @@ FUSE ---- Makes an FS object available to other applications on the system. See :mod:`fs.expose.fuse`. +Dokan +----- +Makes an FS object available to other applications on the system. See :mod:`fs.expose.dokan`. + Secure FTP ---------- Makes an FS object available via Secure FTP. See :mod:`fs.expose.sftp`. diff --git a/docs/expose/dokan.rst b/docs/expose/dokan.rst new file mode 100644 index 0000000..093f076 --- /dev/null +++ b/docs/expose/dokan.rst @@ -0,0 +1,2 @@ +.. automodule:: fs.expose.dokan + :members: diff --git a/docs/expose/index.rst b/docs/expose/index.rst index 0ddc111..19ee319 100644 --- a/docs/expose/index.rst +++ b/docs/expose/index.rst @@ -7,6 +7,7 @@ The ``fs.expose`` module contains a number of options for making an FS implement :maxdepth: 3 fuse.rst + dokan.rst sftp.rst xmlrpc.rst - django_storage.rst
\ No newline at end of file + django_storage.rst diff --git a/docs/index.rst b/docs/index.rst index 6969ee4..7dad2e6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,7 @@ Guide concepts.rst interface.rst filesystems.rst + contrib.rst expose.rst Code Documentation @@ -45,6 +46,7 @@ Code Documentation utils.rst wrapfs/index.rst zipfs.rst + contrib/index.rst Indices and tables |