summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwillmcgugan@gmail.com <willmcgugan@gmail.com@67cdc799-7952-0410-af00-57a81ceafa0f>2014-03-14 17:44:24 +0000
committerwillmcgugan@gmail.com <willmcgugan@gmail.com@67cdc799-7952-0410-af00-57a81ceafa0f>2014-03-14 17:44:24 +0000
commit6c4e125931824947c34527c07ff15a87f1e4c90a (patch)
tree28822d50c2e46d636bc34e788928e79823df3a57
parent70ca3df086e93cb91bd6aff3f7b8aac9abb2c83c (diff)
downloadpyfilesystem-6c4e125931824947c34527c07ff15a87f1e4c90a.tar.gz
Docs update
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@890 67cdc799-7952-0410-af00-57a81ceafa0f
-rw-r--r--docs/conf.py6
-rw-r--r--docs/getting_started.rst30
-rw-r--r--docs/index.rst11
3 files changed, 20 insertions, 27 deletions
diff --git a/docs/conf.py b/docs/conf.py
index ba1d75b..a82283a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -46,16 +46,16 @@ master_doc = 'index'
# General information about the project.
project = u'PyFilesystem'
-copyright = u'2009-2010, Will McGugan, Ryan Kelly'
+copyright = u'2009-2014, Will McGugan, Ryan Kelly'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '0.4'
+version = '0.5'
# The full version, including alpha/beta/rc tags.
-release = '0.4.0'
+release = '0.5.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 66887e1..bdc08d0 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -1,24 +1,16 @@
Getting Started
===============
-PyFilesystem is a Python-only module and can be installed with easy_install or from source. PyFilesystem is known to work on Linux, Mac and OSX.
+PyFilesystem is a Python-only module and can be installed from source or with `pip <http://www.pip-installer.org/>`_. PyFilesystem works on Linux, Mac and OSX.
Installing
----------
-The easiest way to install PyFilesystem is with `easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall>`_::
-
- easy_install fs
-
-Add the -U switch if you want to upgrade a previous installation::
-
- easy_install -U fs
-
-If you prefer to use Pip (http://pypi.python.org/pypi/pip) to install Python packages, the procedure is much the same::
+To install with pip, use the following
pip install fs
-
-Or to upgrade::
+
+Or to upgrade to the most recent version::
pip install fs --upgrade
@@ -32,16 +24,16 @@ Whichever method you use, you should now have the `fs` module on your path (vers
>>> import fs
>>> fs.__version__
- '0.4.0'
+ '0.5.0'
Prerequisites
-------------
-PyFilesystem requires at least **Python 2.5**. There are a few other dependencies if you want to use some of the more advanced filesystem interfaces, but for basic use all that is needed is the Python standard library.
-
+PyFilesystem requires at least **Python 2.6**. There are a few other dependencies if you want to use some of the more advanced filesystem interfaces, but for basic use all that is needed is the Python standard library.
+
* Boto (required for :mod:`fs.s3fs`) http://code.google.com/p/boto/
* Paramiko (required for :class:`fs.ftpfs.FTPFS`) http://www.lag.net/paramiko/
- * wxPython (required for :mod:`fs.browsewin`) http://www.wxpython.org/
+ * wxPython (required for :mod:`fs.browsewin`) http://www.wxpython.org/
Quick Examples
@@ -54,11 +46,11 @@ The following will list all the files in your home directory::
>>> from fs.osfs import OSFS
>>> home_fs = OSFS('~/') # 'c:\Users\<login name>' on Windows
>>> home_fs.listdir()
-
+
Here's how to browse your home folder with a graphical interface::
-
+
>>> home_fs.browse()
-
+
This will display the total number of bytes store in '.py' files your home directory::
>>> sum(home_fs.getsize(f) for f in home_fs.walkfiles(wildcard='*.py'))
diff --git a/docs/index.rst b/docs/index.rst
index ff5d512..d5bcaaf 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,13 +25,14 @@ Guide
utilities.rst
commands.rst
implementersguide.rst
-
+ releasenotes.rst
+
Code Documentation
------------------
-
+
.. toctree::
:maxdepth: 3
-
+
appdirfs.rst
base.rst
browsewin.rst
@@ -55,8 +56,8 @@ Code Documentation
utils.rst
watch.rst
wrapfs/index.rst
- zipfs.rst
-
+ zipfs.rst
+
Indices and tables
==================