Docs tweaks so they're not entirely god-awful now that they're semi-l…

…ive.
fabric · May 1, 2009 · 3427553 · 3427553
1 parent cf20805
commit 3427553
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 58 deletions.
diff --git a/docs/api/context_managers.rst b/docs/api/context_managers.rst
@@ -0,0 +1,6 @@
+================
+Context Managers
+================
+
+.. automodule:: fabric.context_managers
+    :members: warnings_only
diff --git a/docs/api/decorators.rst b/docs/api/decorators.rst
@@ -3,4 +3,4 @@ Decorators
 ==========
 
 .. automodule:: fabric.decorators
-    :members:
+    :members: hosts, roles, runs_once
diff --git a/docs/compatibility.rst b/docs/compatibility.rst
@@ -31,14 +31,18 @@ sample fabfile that works with 0.1 and earlier::
 The above fabfile uses `hosts`, `run` and `sudo`, and so in Fabric 0.9 one
 simply needs to add the following imports::
 
-     from fabric.decorators import hosts
-     from fabric.operations import run, sudo
+     from fabric.api import hosts, run, sudo
  
      @hosts('a', 'b')
      def my_task():
          run('ls /var/www')
          sudo('mkdir /var/www/newsite')
 
+You may, if you wish, use ``from fabric.api import *``, though this is
+technically not Python best practices; or you may import directly from the
+Fabric submodules if you desire (e.g. ``from fabric.decorators import hosts``.)
+See :doc:`usage` for a permanent version of this information.
+
 Python version
 --------------
 

diff --git a/docs/downloads.rst b/docs/downloads.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,22 +2,32 @@
 Fabric
 ======
 
+Work in progress!
+=================
+
+This website and its documentation are still being written and updated during
+Fabric 0.9's alpha and beta periods. We are providing them to you now because
+any documentation is better than no documentation, but please keep in mind that
+many things here are subject to change or may lack documentation.
+
 
 About
 =====
 
 .. include:: ../README
 
 
-Download
-========
+Download/Installation
+=====================
 
 Latest stable version
 ---------------------
 
-The most recent stable version of Fabric is |version| and may be downloaded
-from the :doc:`downloads` page, which also contains previous versions as well
-as installation instructions.
+The most recent stable version of Fabric is |release|. The recommended
+installation method is to use ``easy_install`` or ``pip``; or you may download
+TGZ or ZIP archives from `the Fabric cgit page <http://git.fabfile.org>`_.
+Detailed install instructions for any of these methods can be found on the
+:doc:`installation` page.
 
 Development version
 -------------------
@@ -73,7 +83,6 @@ Getting Fabric
 .. toctree::
     :maxdepth: 2
 
-    downloads
     installation
     development
 

diff --git a/fabric/context_managers.py b/fabric/context_managers.py
@@ -25,7 +25,7 @@ def warnings_only():
 
         def my_task():
             run('/not/gonna/happen')
-
+    
     However, with the use of `warnings_only`, the same call is guaranteed to
     warn only, and will never halt execution of the program:: 
 
@@ -38,8 +38,8 @@ def my_task():
         and not a context manager itself.
 
     .. note:: Remember that on Python 2.5, you will need to start your fabfile
-    with ``from __future__ import with_statement`` in order to make use of this
-    feature.
+        with ``from __future__ import with_statement`` in order to make use of
+        this feature.
 
     """
     previous = env.abort_on_failure